{
  "x-generated": "Generated by the Hyperscale artifact pipeline; do not edit by hand",
  "openapi": "3.1.1",
  "jsonSchemaDialect": "https://spec.openapis.org/oas/3.1/dialect/base",
  "x-hyperscale-audience": "tenant_sdk",
  "x-hyperscale-error-catalog": [
    {
      "code": "account_close_balance_nonzero",
      "httpStatus": 409,
      "cause": "The request contradicts the Account the platform has already durably recorded (`account close balance nonzero`).",
      "action": "Re-read the Account with `account.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Account as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_freeze_plane_forbidden",
      "httpStatus": 409,
      "cause": "The account carries a platform-imposed freeze, and tenant-plane unfreeze or close cannot lift or bypass it.",
      "action": "Stop retrying from this surface; the freeze on this account is not yours to lift.",
      "remediation": "Contact platform support about the account restriction; the transition succeeds once the platform lifts its freeze.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_frozen",
      "httpStatus": 409,
      "cause": "The account is frozen. Debits always refuse while frozen; some freezes also refuse credits. The error message carries the only reason wording Hyperscale exposes.",
      "action": "Use a different account for this transfer leg, or have the freeze lifted before retrying.",
      "remediation": "Unfreeze the account through its lifecycle surface if you imposed the freeze; a freeze you cannot lift was imposed by the platform and clears only when the platform lifts it.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_ledger_mapping_conflict",
      "httpStatus": 409,
      "cause": "The request contradicts the Account the platform has already durably recorded (`account ledger mapping conflict`).",
      "action": "Re-read the Account with `account.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Account as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_ledger_mapping_dangling",
      "httpStatus": 409,
      "cause": "This Account names the ledger account that holds its money, and the ledger does not have that account. An Account and its ledger side are written together, so this is not a half-made Account: this deployment's records and the ledger it is reading have drifted apart. That happens when the engine is pointed at a different ledger cluster than the one these Accounts were created against, or when a cluster is restored to a point behind them.",
      "action": "Send the error details to whoever operates this Hyperscale deployment; no change to the request will clear this refusal, and no figures were produced.",
      "remediation": "Only an operator can settle which ledger this deployment reads; until then the balance is unknowable and the refusal is the honest answer, because the alternative is reporting a figure for money that may well exist somewhere else. Other Accounts on the same organization answer normally -- a refusal on one Account and not its neighbours narrows the drift to that Account's mapping rather than the connection.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_ledger_unprovisioned",
      "httpStatus": 409,
      "cause": "This Account exists but has no ledger account behind it, so it holds no balances and no movements to report. Creating an Account provisions its ledger side; an Account in this state was recorded before that provisioning completed, or the provisioning did not finish.",
      "action": "Read the Account back and confirm it finished provisioning, then run this read again. No figures were produced.",
      "remediation": "Nothing about the request changes this, and a retry only succeeds once provisioning completes. If the Account has been in this state for more than a moment its ledger provisioning failed and an operator of this deployment has to finish it -- until then no money can enter or leave the Account, so there is nothing for a balance or a statement to report.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_not_found",
      "httpStatus": 404,
      "cause": "No Account matches the `accountId` this request referenced (`account not found`).",
      "action": "List Accounts in the same tenant, product, and environment, then retry with the `accountId` that read returns.",
      "remediation": "Create or select the Account in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_role_not_financial_addressable",
      "httpStatus": 400,
      "cause": "The operation refused the request on its `account role not financial addressable` contract condition.",
      "action": "Read the error details, then the operation reference for this Account, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the Account; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_role_owner_mismatch",
      "httpStatus": 400,
      "cause": "The request contradicts the Account the platform has already durably recorded (`account role owner mismatch`).",
      "action": "Re-read the Account with `account.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Account as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "account_status_forbidden",
      "httpStatus": 409,
      "cause": "The account is not in a state that allows this lifecycle transition (for example, freezing a closed account or closing a frozen one). The current status is returned in the error details.",
      "action": "Read the account's current status and choose the lifecycle operation valid from that state.",
      "remediation": "Refresh the account and apply the transition allowed from its current status; the account reference itself is valid, so no new account is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "aggregate_condition_unmet",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`aggregate condition unmet`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "beneficiary_id_reserved",
      "httpStatus": 409,
      "cause": "The requested beneficiary id is the platform-reserved identity of the per-tenant revenue beneficiary that only Hyperscale's billing sweep may provision.",
      "action": "Create the beneficiary under a different id (or omit `beneficiaryId` and let Hyperscale assign one); this id is reserved for Hyperscale's own invoice collection.",
      "remediation": "The revenue beneficiary is created automatically the first time the billing sweep runs -- no tenant ever needs to create it. Pick any other id (or none) for your own beneficiaries and retry with a new Idempotency-Key.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "collection_authorization_unverified",
      "httpStatus": 409,
      "cause": "The request contradicts the Collection the platform has already durably recorded (`collection authorization unverified`).",
      "action": "Re-read the Collection with `collection.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Collection as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "collection_not_found",
      "httpStatus": 404,
      "cause": "No Collection matches the `collectionId` this request referenced (`collection not found`).",
      "action": "List Collections in the same tenant, product, and environment, then retry with the `collectionId` that read returns.",
      "remediation": "Create or select the Collection in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "collection_status_forbidden",
      "httpStatus": 409,
      "cause": "The Collection's current lifecycle state does not allow this transition (`collection status forbidden`).",
      "action": "Read the Collection with `collection.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Collection's current status permits. The reference itself is still valid, so no new Collection is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "collection_transfer_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the Collection the platform has already durably recorded (`collection transfer mismatch`).",
      "action": "Re-read the Collection with `collection.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Collection as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "consent_expired",
      "httpStatus": 403,
      "cause": "The operation refused the request on its `consent expired` contract condition.",
      "action": "Read the error details, then the operation reference for this Consent, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the Consent; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "consent_not_active",
      "httpStatus": 409,
      "cause": "The request contradicts the Consent the platform has already durably recorded (`consent not active`).",
      "action": "Re-read the Consent with `consent.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Consent as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "consent_not_found",
      "httpStatus": 404,
      "cause": "No Consent matches the `consentId` this request referenced (`consent not found`).",
      "action": "List Consents in the same tenant, product, and environment, then retry with the `consentId` that read returns.",
      "remediation": "Create or select the Consent in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "consent_revoked",
      "httpStatus": 403,
      "cause": "The operation refused the request on its `consent revoked` contract condition.",
      "action": "Read the error details, then the operation reference for this Consent, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the Consent; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "cross_tenant_transfer_forbidden",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`cross tenant transfer forbidden`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "csrf_token_invalid",
      "httpStatus": 403,
      "cause": "A browser session mutation did not carry a current Hyperscale CSRF token.",
      "action": "Refresh the portal page or session, then submit the form again.",
      "remediation": "Use the portal login flow to refresh the session before retrying the mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "currency_mismatch",
      "httpStatus": 400,
      "cause": "The currency on the request does not match the settlement currency of the account or transfer it targets. Hyperscale never converts between currencies, so the two must be identical.",
      "action": "Read the target account's currency (for example with `account.balance.retrieve`) and resend with that same currency and a minor-unit amount denominated in it.",
      "remediation": "This is deterministic. Retrying with the same currency fails identically. Correct the request's currency field, or move the money through an account already denominated in the required currency, then retry.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_access_compliance_forbidden",
      "httpStatus": 403,
      "cause": "The request contradicts the Customer access the platform has already durably recorded (`customer access compliance forbidden`).",
      "action": "Re-read the Customer access with `customer_access.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Customer access as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "additionalHttpStatuses": [
        409
      ],
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_access_lifecycle_status_forbidden",
      "httpStatus": 409,
      "cause": "The Customer access's current lifecycle state does not allow this transition (`customer access lifecycle status forbidden`).",
      "action": "Read the Customer access with `customer_access.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Customer access's current status permits. The reference itself is still valid, so no new Customer access is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_access_not_found",
      "httpStatus": 404,
      "cause": "No Customer access matches the `customerAccessId` this request referenced (`customer access not found`).",
      "action": "List Customer accesses in the same tenant, product, and environment, then retry with the `customerAccessId` that read returns.",
      "remediation": "Create or select the Customer access in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_access_required",
      "httpStatus": 403,
      "cause": "The operation cannot run against this Customer access until the `customer access required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Customer access, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Customer access names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_access_status_forbidden",
      "httpStatus": 409,
      "cause": "The Customer access's current lifecycle state does not allow this transition (`customer access status forbidden`).",
      "action": "Read the Customer access with `customer_access.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Customer access's current status permits. The reference itself is still valid, so no new Customer access is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_not_found",
      "httpStatus": 404,
      "cause": "No Customer matches the `customerId` this request referenced (`customer not found`).",
      "action": "List Customers in the same tenant, product, and environment, then retry with the `customerId` that read returns.",
      "remediation": "Create or select the Customer in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "customer_status_forbidden",
      "httpStatus": 403,
      "cause": "The Customer's current lifecycle state does not allow this transition (`customer status forbidden`).",
      "action": "Read the Customer with `customer.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Customer's current status permits. The reference itself is still valid, so no new Customer is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "destination_account_status_forbidden",
      "httpStatus": 400,
      "cause": "The destination (credit) account is not open. It is frozen or closed, so Hyperscale will not credit it.",
      "action": "Use a destination account whose status is `open`, or unfreeze the intended account, before retrying.",
      "remediation": "Read the account status, unfreeze it (or select an open account in the same currency and workspace), then resend the transfer.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "developer_log_not_found",
      "httpStatus": 404,
      "cause": "No resource matches the `id` this request referenced (`developer log not found`).",
      "action": "List the collection this request referenced in the same tenant, product, and environment, then retry with an `id` that listing returns.",
      "remediation": "Create or select the resource in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "entity_not_found",
      "httpStatus": 404,
      "cause": "No Entity matches the `entityId` this request referenced (`entity not found`).",
      "action": "List Entities in the same tenant, product, and environment, then retry with the `entityId` that read returns.",
      "remediation": "Create or select the Entity in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "entity_status_forbidden",
      "httpStatus": 403,
      "cause": "The Entity's current lifecycle state does not allow this transition (`entity status forbidden`).",
      "action": "Read the Entity with `entity.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Entity's current status permits. The reference itself is still valid, so no new Entity is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "exposure_cap_exceeded",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`exposure cap exceeded`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "external_confirmation_conflict",
      "httpStatus": 409,
      "cause": "The request contradicts the External Confirmation the platform has already durably recorded (`external confirmation conflict`).",
      "action": "Re-read the External Confirmation with `external_confirmation.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the External Confirmation as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "external_confirmation_not_found",
      "httpStatus": 404,
      "cause": "No External Confirmation matches the `externalConfirmationId` this request referenced (`external confirmation not found`).",
      "action": "List External Confirmations in the same tenant, product, and environment, then retry with the `externalConfirmationId` that read returns.",
      "remediation": "Create or select the External Confirmation in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "external_confirmation_resource_conflict",
      "httpStatus": 409,
      "cause": "The request contradicts the External Confirmation the platform has already durably recorded (`external confirmation resource conflict`).",
      "action": "Re-read the External Confirmation with `external_confirmation.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the External Confirmation as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "financial_address_account_status_forbidden",
      "httpStatus": 400,
      "cause": "The Financial address's current lifecycle state does not allow this transition (`financial address account status forbidden`).",
      "action": "Read the Financial address with `financial_address.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Financial address's current status permits. The reference itself is still valid, so no new Financial address is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "financial_address_destination_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the Financial address the platform has already durably recorded (`financial address destination mismatch`).",
      "action": "Re-read the Financial address with `financial_address.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Financial address as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "financial_address_lifecycle_status_forbidden",
      "httpStatus": 409,
      "cause": "The Financial address's current lifecycle state does not allow this transition (`financial address lifecycle status forbidden`).",
      "action": "Read the Financial address with `financial_address.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Financial address's current status permits. The reference itself is still valid, so no new Financial address is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "financial_address_not_found",
      "httpStatus": 404,
      "cause": "No Financial address matches the `financialAddressId` this request referenced (`financial address not found`).",
      "action": "List Financial addresses in the same tenant, product, and environment, then retry with the `financialAddressId` that read returns.",
      "remediation": "Create or select the Financial address in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "financial_address_status_forbidden",
      "httpStatus": 400,
      "cause": "The Financial address's current lifecycle state does not allow this transition (`financial address status forbidden`).",
      "action": "Read the Financial address with `financial_address.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Financial address's current status permits. The reference itself is still valid, so no new Financial address is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "funding_destination_role_forbidden",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`funding destination role forbidden`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "idempotency_conflict",
      "httpStatus": 409,
      "cause": "The request reused an Idempotency-Key for a different logical mutation.",
      "action": "Reuse an Idempotency-Key only with the exact same method, path, body, and tenant.",
      "remediation": "Generate a new key for the new mutation, or replay the original request unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "idempotency_required",
      "httpStatus": 400,
      "cause": "The operation is a mutation and Hyperscale requires a replay key before executing it.",
      "action": "Send an Idempotency-Key header for this mutation.",
      "remediation": "Let the SDK create the key automatically, or provide a stable key per logical mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "insufficient_balance",
      "httpStatus": 409,
      "cause": "The source (debit) account's available balance is below the transfer amount, so the ledger refused the transfer. No money moved. The transfer was not created and its charge/transfer rows are recorded as failed.",
      "action": "Fund the source (debit) account so its available balance in minor units covers the full amount, or lower the amount, then retry. Confirm the shortfall first with `account.balance.retrieve`.",
      "remediation": "This is a definitive refusal, not a transient failure: replaying the exact request with the same Idempotency-Key safely returns this same refusal and never double-charges, so rotating to a fresh key is not the fix. Funding is. Top up the source account (or reduce the amount), then submit the transfer as a new request.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "internal_error",
      "httpStatus": 500,
      "cause": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience.",
      "action": "Capture the request ID, operation ID, and receipt ID if present before escalating.",
      "remediation": "Retry only if the operation is documented as retryable; otherwise contact Hyperscale support with the tracing IDs.",
      "retryable": false,
      "idempotencySafe": false
    },
    {
      "code": "invalid_credentials",
      "httpStatus": 401,
      "cause": "Hyperscale could not accept the account or credential request. Signup, login, and bearer authentication use one 401 for every case they reject, so the response exposes no credential-specific reason or registered-email verdict. The single exception is a key that is real but homed in the other environment: because the presented secret already matched a stored key, the message names the mismatch instead of leaving a working credential looking unknown.",
      "action": "For signup or login, re-check the submitted account details. For API calls, re-check the `Authorization: Bearer <key>` API key and whether it matches the target environment (sandbox vs live).",
      "remediation": "For signup, verify the submitted details or use login or password reset for an existing account. For login, re-enter the credentials or reset the password. For API or MCP calls, use an active key for the target environment, set HYPERSCALE_API_KEY, and retry. When the message reports an environment mismatch, `details.keyEnvironment` names where the key does work: send that environment's key, or set `X-Hyperscale-Environment` to it.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "invalid_noun_transition",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`invalid noun transition`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "invalid_request",
      "httpStatus": 400,
      "cause": "The request does not match the API reference.",
      "action": "Compare the request path, method, headers, and JSON body to the expected request shape.",
      "remediation": "Use the SDK input types or API reference, then resend with valid JSON and required headers.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "kyc_country_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`kyc country unsupported`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "kyc_tier_insufficient",
      "httpStatus": 403,
      "cause": "Opening an account of this role requires the owning customer's entity to have ATTAINED a KYC tier it has not reached: either required fields are missing or the profile is not verified.",
      "action": "Complete and verify the entity's KYC profile to the tier this account role requires, then retry. The error details name the required tier and the entity's attained tier.",
      "remediation": "Submit the missing fields (`entity.kyc.submit`), run verification (`entity.kyc.verification.start`), and once the outcome is verified at the required tier the account open succeeds unchanged. `entity.kyc.retrieve` shows exactly which fields stand between the entity and the required tier.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "ledger_transfer_rejected",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`ledger transfer rejected`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "ledger_unavailable",
      "httpStatus": 503,
      "cause": "The platform could not durably complete the `ledger unavailable` step, so the resource may or may not have been written.",
      "action": "Capture the request id and the receipt or operation id before retrying or escalating; do not re-send under a fresh key until you know whether the resource was written.",
      "remediation": "Treat the resource's side effects as unknown unless a terminal receipt says otherwise; retry only operations documented as retryable, and replay them with the SAME idempotency key.",
      "retryable": true,
      "idempotencySafe": false
    },
    {
      "code": "mfa_verification_required",
      "httpStatus": 403,
      "cause": "This tenant surface requires a session that completed TOTP at login. Tenant operations demand it while the organization's require-MFA policy (tenant.security.configure) is on; user.mfa.totp.disable demands it unconditionally, because removing a factor is the act that factor exists to guard.",
      "action": "Enroll and confirm a TOTP factor (user.mfa.totp.enrollment.begin, then user.mfa.totp.enrollment.confirm), then log in again and complete user.login.mfa.verify before retrying.",
      "remediation": "MFA verification is a mint-time session fact, so enrolling a factor mid-session never upgrades the current session. After the factor is active, a fresh login returns an MFA challenge; completing it mints the verified session this surface demands. Identity self-operations (logout, TOTP enrollment) stay open to a password-only session, so a factorless member is never locked out of enrolling. Disabling a factor is the exception: sign in again and complete the challenge first.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "missing_required_permission",
      "httpStatus": 403,
      "cause": "The signed-in member's current role does not grant the permission required for this operation.",
      "action": "Ask an organization owner to assign a role containing the required portal permission, then sign in again if your existing session was revoked by the role change.",
      "remediation": "Review the member's role in the Team desk, add only the required permission to a custom role or assign an appropriate seeded role, and retry with that member's session.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "missing_required_scope",
      "httpStatus": 403,
      "cause": "The credential is valid but does not grant one or more operation scopes.",
      "action": "Create or rotate an API key with the required access.",
      "remediation": "Use the portal API key page or `api_key.sandbox.create` after Product creation to create a scoped key.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "missing_required_workspace_capability",
      "httpStatus": 403,
      "cause": "The Product was created without a capability required by this operation.",
      "action": "Call the operation from a Product whose provisioned capability set includes the required capability.",
      "remediation": "Create or replace the Product on a path that provisions the required capability before creating the API key.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "not_found",
      "httpStatus": 404,
      "cause": "No Hyperscale route matched the requested path and method.",
      "action": "Verify the URL and request method against the API reference.",
      "remediation": "Use the SDK method or OpenAPI path for the operation instead of constructing the URL by hand.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_account_not_drained",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun account not drained`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_aggregate_cap_exceeded",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun aggregate cap exceeded`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_aggregate_currency_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun aggregate currency mismatch`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_decision_declined",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun decision declined`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_decision_timeout",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun decision timeout`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_instance_not_found",
      "httpStatus": 404,
      "cause": "No Noun instance matches the `nounInstanceId` this request referenced (`noun instance not found`).",
      "action": "List Noun instances in the same tenant, product, and environment, then retry with the `nounInstanceId` that read returns.",
      "remediation": "Create or select the Noun instance in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_partition_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun partition mismatch`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_reference_already_claimed",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun reference already claimed`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_reference_incongruent",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun reference incongruent`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_reference_not_found",
      "httpStatus": 404,
      "cause": "No resource matches the `id` this request referenced (`noun reference not found`).",
      "action": "List the collection this request referenced in the same tenant, product, and environment, then retry with an `id` that listing returns.",
      "remediation": "Create or select the resource in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_reference_required",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun reference required`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_reference_status_forbidden",
      "httpStatus": 409,
      "cause": "The resource's current lifecycle state does not allow this transition (`noun reference status forbidden`).",
      "action": "Read the resource this request referenced and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the resource's current status permits. The reference itself is still valid, so no new resource is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_remainder_exceeded",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun remainder exceeded`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_retired",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun retired`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_subject_kind_forbidden",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`noun subject kind forbidden`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "noun_subject_not_found",
      "httpStatus": 409,
      "cause": "No resource matches the `id` this request referenced (`noun subject not found`).",
      "action": "List the collection this request referenced in the same tenant, product, and environment, then retry with an `id` that listing returns.",
      "remediation": "Create or select the resource in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "operation_environment_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Operation accepts (`operation environment invalid`).",
      "action": "Replace the rejected value with one this Operation allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Operation, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "operation_not_allowed",
      "httpStatus": 403,
      "cause": "The credential authenticated, but the operation is outside the allowlist its Product's composition produced. The message names the operation and the capability that would admit it.",
      "action": "Call an operation inside this key's composition, or recompose the Product to include the one you want.",
      "remediation": "Compose the Product with the named capability and issue a key from it, or use the scoped SDK/OpenAPI for this key, which publishes exactly the operations it can run.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "operation_not_finalized",
      "httpStatus": 409,
      "cause": "The request contradicts the Operation the platform has already durably recorded (`operation not finalized`).",
      "action": "Re-read the Operation with `operation.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Operation as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "owner_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`owner unsupported`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "payout_beneficiary_reserved",
      "httpStatus": 409,
      "cause": "The named beneficiary is the platform-provisioned revenue beneficiary that only Hyperscale's billing sweep may pay.",
      "action": "Send the payout to a beneficiary you created; this one is reserved for Hyperscale's own invoice collection.",
      "remediation": "Invoices are collected automatically by the billing sweep -- no tenant payout is ever needed toward this beneficiary. Create and verify your own beneficiary for outbound payments.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "port_actor_not_allowed",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`port actor not allowed`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "product_access_suspended",
      "httpStatus": 403,
      "cause": "The Product is disabled or closed, so its credentials are suspended in every environment.",
      "action": "Use an active Product before sending traffic.",
      "remediation": "Reactivate the Product from its settings page (or replace it), then retry with credentials of the active Product.",
      "environment": "live",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "product_activation_required",
      "httpStatus": 403,
      "cause": "The live Product or required live capability is not active yet.",
      "action": "Activate the Product and live-enable the required capability before sending production traffic.",
      "remediation": "Complete Product activation, satisfy live requirements, and enable the capability before retrying.",
      "environment": "live",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "provider_egress_failed",
      "httpStatus": 502,
      "cause": "The platform could not durably complete the `provider egress failed` step, so the resource may or may not have been written.",
      "action": "Capture the request id and the receipt or operation id before retrying or escalating; do not re-send under a fresh key until you know whether the resource was written.",
      "remediation": "Treat the resource's side effects as unknown unless a terminal receipt says otherwise; retry only operations documented as retryable, and replay them with the SAME idempotency key.",
      "retryable": true,
      "idempotencySafe": false
    },
    {
      "code": "provider_egress_rejected",
      "httpStatus": 422,
      "cause": "The operation refused the request on its `provider egress rejected` contract condition.",
      "action": "Read the error details, then the operation reference for this resource, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the resource; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "provider_outcome_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`provider outcome unsupported`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "rate_limited",
      "httpStatus": 429,
      "cause": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated.",
      "action": "Back off for the response retry window before sending the next request.",
      "remediation": "Spread bursts, batch reads, and respect the response rate limit headers.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "request_body_too_large",
      "httpStatus": 413,
      "cause": "The JSON request body exceeded Hyperscale's accepted payload size.",
      "action": "Reduce the request body size and move large payloads to supported external storage.",
      "remediation": "Send only contract fields and references needed by the operation, then retry with a smaller body.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "resource_not_found",
      "httpStatus": 404,
      "cause": "The requested resource does not exist in the credential's visible scope.",
      "action": "Confirm the resource ID belongs to the same tenant, product, and environment as the credential.",
      "remediation": "Read or create the resource in the same sandbox/live environment before calling this operation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "resource_reader_unavailable",
      "httpStatus": 503,
      "cause": "A generated read model could not serve the request at this moment.",
      "action": "Retry with the same request after the read model or backing dependency recovers.",
      "remediation": "Use SDK retries for eligible reads; keep the same tenant/environment and escalate if it persists.",
      "retryable": false,
      "idempotencySafe": false
    },
    {
      "code": "session_expired",
      "httpStatus": 401,
      "cause": "The operation refused the request on its `session expired` contract condition.",
      "action": "Read the error details, then the operation reference for this resource, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the resource; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "session_not_found",
      "httpStatus": 404,
      "cause": "No resource matches the `id` this request referenced (`session not found`).",
      "action": "List the collection this request referenced in the same tenant, product, and environment, then retry with an `id` that listing returns.",
      "remediation": "Create or select the resource in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "session_required",
      "httpStatus": 401,
      "cause": "The operation cannot run against this resource until the `session required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this resource, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this resource names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "session_revoked",
      "httpStatus": 401,
      "cause": "The operation refused the request on its `session revoked` contract condition.",
      "action": "Read the error details, then the operation reference for this resource, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the resource; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "source_account_status_forbidden",
      "httpStatus": 400,
      "cause": "The source (debit) account is not open. It is frozen or closed, so Hyperscale will not debit it.",
      "action": "Use a source account whose status is `open`, or unfreeze the intended account, before retrying.",
      "remediation": "Read the account status, unfreeze it (or select an open account in the same currency and workspace), then resend the transfer.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "source_operation_not_found",
      "httpStatus": 404,
      "cause": "No resource matches the `id` this request referenced (`source operation not found`).",
      "action": "List the collection this request referenced in the same tenant, product, and environment, then retry with an `id` that listing returns.",
      "remediation": "Create or select the resource in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "state_conflict",
      "httpStatus": 409,
      "cause": "The operation conflicts with the current durable state of the resource.",
      "action": "Refresh the resource and retry from its current lifecycle state.",
      "remediation": "List or retrieve the resource first, then call the next valid operation for its state.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "state_constraint_failed",
      "httpStatus": 422,
      "cause": "The request is syntactically valid but violates a business-state constraint.",
      "action": "Fix the semantic field combination called out by the error details.",
      "remediation": "Use the operation docs and typed input model to adjust the values before retrying.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "statement_evidence_incomplete",
      "httpStatus": 409,
      "cause": "One of this month's ledger movements has no complete receipt behind it: no finalized receipt claims that transfer, more than one does, or the receipt that claims it is missing the linkage a statement line is built from. A statement is only ever derived from receipts, so the month is refused whole rather than issued with a line no receipt can back. The error details name the ledger transfer and the receipt the check stopped on.",
      "action": "Read the month on the treasury window to see how far the gap runs, and ask whoever operates this deployment to repair the receipt the error details name. No statement was issued and no figures were produced.",
      "remediation": "Nothing in the request causes this and no retry clears it: the same month refuses until the receipt linkage is repaired, which only an operator of this deployment can do. Balances are untouched -- the account's balance read still answers, and every other month still issues -- so the treasury window is the fastest way to see whether one month or a run of them is affected.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "statement_evidence_mismatch",
      "httpStatus": 409,
      "cause": "This month's records disagree with each other. Either a ledger movement and the receipt claiming it differ on amount, currency, account side, phase, or the transfer resource behind them, or the lines those receipts describe do not add up to the closing balance the ledger reports for the month. Both records are immutable, so the read refuses rather than issue a statement from whichever one it picked.",
      "action": "Compare the ledger transfer and the receipt the error details name; a statement can only be issued once they agree, which is repair work for whoever operates this deployment. No statement was issued and no figures were produced.",
      "remediation": "This is a fact about stored records, so retrying, re-authenticating, or asking for a narrower period all return the same refusal. The account and its balances are unaffected and neighbouring months still issue. Repair means correcting the disagreement at its source -- the receipt for that movement -- after which the month issues normally with no change to this call.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "statement_line_limit_exceeded",
      "httpStatus": 413,
      "cause": "This account recorded more than 50,000 movements in the requested month -- more activity than a single monthly statement can carry. The account and its balances are fine; the month is too large to render as one document. The error details carry the exact limit.",
      "action": "Read the month on the accounts that make this one up, rather than on the pooled account itself. No statement was issued and no figures were produced.",
      "remediation": "A statement is a whole UTC month by definition, so there is no second page to ask for and no date range that narrows it. An account this busy is almost always a pooled account: read the per-customer or per-product accounts beneath it, whose months each fall within the limit, and their opening and closing balances add back to the same totals.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "system_principal_required",
      "httpStatus": 403,
      "cause": "The operation is restricted to the system principal.",
      "action": "Use an operator/system credential instead of a tenant API key.",
      "remediation": "Run the equivalent tenant-safe operation when available, or route through the admin/system surface.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "tenant_bank_confirmation_required",
      "httpStatus": 409,
      "cause": "The request contradicts the Company the platform has already durably recorded (`tenant bank confirmation required`).",
      "action": "Re-read the Company with `tenant.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Company as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "tenant_mismatch",
      "httpStatus": 403,
      "cause": "The request mixed tenant-owned identifiers across tenant boundaries.",
      "action": "Use resource IDs, product IDs, and credentials from the same tenant.",
      "remediation": "Recreate the request from the current tenant's product in the portal or from the generated SDK context.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "tenant_not_found",
      "httpStatus": 404,
      "cause": "The credential resolved to a tenant Hyperscale cannot find.",
      "action": "Sign in again or use an API key issued for an existing tenant.",
      "remediation": "Sign in, create a product, and create a fresh product API key before retrying.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_adjustment_amount_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`transfer adjustment amount invalid`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_destination_role_forbidden",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`transfer destination role forbidden`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_expiry_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`transfer expiry invalid`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_expiry_past",
      "httpStatus": 400,
      "cause": "The operation refused the request on its `transfer expiry past` contract condition.",
      "action": "Read the error details, then the operation reference for this resource, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the resource; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_expiry_too_large",
      "httpStatus": 400,
      "cause": "The operation refused the request on its `transfer expiry too large` contract condition.",
      "action": "Read the error details, then the operation reference for this resource, before retrying.",
      "remediation": "Correct the request against the generated SDK models and a fresh read of the resource; if the shape is already right, the product may be missing the capability this operation needs.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_lineage_conflict",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`transfer lineage conflict`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_not_found",
      "httpStatus": 404,
      "cause": "No resource matches the `id` this request referenced (`transfer not found`).",
      "action": "List the collection this request referenced in the same tenant, product, and environment, then retry with an `id` that listing returns.",
      "remediation": "Create or select the resource in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_post_amount_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`transfer post amount invalid`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_role_pair_forbidden",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`transfer role pair forbidden`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_source_role_forbidden",
      "httpStatus": 400,
      "cause": "The submitted value is not one this resource accepts (`transfer source role forbidden`).",
      "action": "Replace the rejected value with one this resource allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this resource, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "transfer_status_forbidden",
      "httpStatus": 409,
      "cause": "The transfer is not in the state this operation requires (for example, posting needs a reserved transfer; returning or reversing needs a posted one). The current and required states are described in the error message.",
      "action": "Read the transfer's current status and call the operation that is valid for that status.",
      "remediation": "Follow the transfer lifecycle (reserve → post, then return/reverse) and issue the operation matching the transfer's current state instead of the rejected one.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_case_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust Review evidence the platform has already durably recorded (`trust evidence case mismatch`).",
      "action": "Re-read the Trust Review evidence with `trust_evidence.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust Review evidence as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_checksum_algorithm_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review evidence accepts (`trust evidence checksum algorithm unsupported`).",
      "action": "Replace the rejected value with one this Trust Review evidence allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review evidence, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_checksum_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review evidence accepts (`trust evidence checksum invalid`).",
      "action": "Replace the rejected value with one this Trust Review evidence allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review evidence, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_checksum_required",
      "httpStatus": 400,
      "cause": "The operation cannot run against this Trust Review evidence until the `trust evidence checksum required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Trust Review evidence, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Trust Review evidence names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_document_type_required",
      "httpStatus": 400,
      "cause": "The operation cannot run against this Trust Review evidence until the `trust evidence document type required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Trust Review evidence, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Trust Review evidence names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_document_type_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review evidence accepts (`trust evidence document type unsupported`).",
      "action": "Replace the rejected value with one this Trust Review evidence allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review evidence, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_duplicate_checksum",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust Review evidence the platform has already durably recorded (`trust evidence duplicate checksum`).",
      "action": "Re-read the Trust Review evidence with `trust_evidence.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust Review evidence as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_kind_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review evidence accepts (`trust evidence kind unsupported`).",
      "action": "Replace the rejected value with one this Trust Review evidence allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review evidence, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_evidence_not_found",
      "httpStatus": 404,
      "cause": "No Trust Review evidence matches the `trustEvidenceId` this request referenced (`trust evidence not found`).",
      "action": "List Trust Review evidence in the same tenant, product, and environment, then retry with the `trustEvidenceId` that read returns.",
      "remediation": "Create or select the Trust Review evidence in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_requirement_evidence_stale",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust Review requirement the platform has already durably recorded (`trust requirement evidence stale`).",
      "action": "Re-read the Trust Review requirement with `trust_requirement.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust Review requirement as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_requirement_not_found",
      "httpStatus": 404,
      "cause": "No Trust Review requirement matches the `trustRequirementId` this request referenced (`trust requirement not found`).",
      "action": "List Trust Review requirements in the same tenant, product, and environment, then retry with the `trustRequirementId` that read returns.",
      "remediation": "Create or select the Trust Review requirement in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_requirement_proof_source_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review requirement accepts (`trust requirement proof source unsupported`).",
      "action": "Replace the rejected value with one this Trust Review requirement allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review requirement, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_requirement_provider_proof_required",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust Review requirement the platform has already durably recorded (`trust requirement provider proof required`).",
      "action": "Re-read the Trust Review requirement with `trust_requirement.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust Review requirement as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_requirement_status_forbidden",
      "httpStatus": 409,
      "cause": "The Trust Review requirement's current lifecycle state does not allow this transition (`trust requirement status forbidden`).",
      "action": "Read the Trust Review requirement with `trust_requirement.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Trust Review requirement's current status permits. The reference itself is still valid, so no new Trust Review requirement is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_requirement_status_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review requirement accepts (`trust requirement status unsupported`).",
      "action": "Replace the rejected value with one this Trust Review requirement allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review requirement, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_business_identity_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust review the platform has already durably recorded (`trust review business identity mismatch`).",
      "action": "Re-read the Trust review with `trust_review.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust review as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_business_profile_not_found",
      "httpStatus": 404,
      "cause": "No Trust review matches the `trustReviewId` this request referenced (`trust review business profile not found`).",
      "action": "List Trust reviews in the same tenant, product, and environment, then retry with the `trustReviewId` that read returns.",
      "remediation": "Create or select the Trust review in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_decision_reason_code_required",
      "httpStatus": 400,
      "cause": "The operation cannot run against this Trust review until the `trust review decision reason code required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Trust review, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Trust review names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_decision_reason_code_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust review accepts (`trust review decision reason code unsupported`).",
      "action": "Replace the rejected value with one this Trust review allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust review, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_not_approved",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust review the platform has already durably recorded (`trust review not approved`).",
      "action": "Re-read the Trust review with `trust_review.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust review as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_not_found",
      "httpStatus": 404,
      "cause": "No Trust review matches the `trustReviewId` this request referenced (`trust review not found`).",
      "action": "List Trust reviews in the same tenant, product, and environment, then retry with the `trustReviewId` that read returns.",
      "remediation": "Create or select the Trust review in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_ownership_exceeds_total",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust review the platform has already durably recorded (`trust review ownership exceeds total`).",
      "action": "Re-read the Trust review with `trust_review.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust review as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_registration_status_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust review accepts (`trust review registration status unsupported`).",
      "action": "Replace the rejected value with one this Trust review allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust review, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_risk_level_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust review accepts (`trust review risk level unsupported`).",
      "action": "Replace the rejected value with one this Trust review allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust review, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_risk_score_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust review accepts (`trust review risk score invalid`).",
      "action": "Replace the rejected value with one this Trust review allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust review, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_status_forbidden",
      "httpStatus": 409,
      "cause": "The Trust review's current lifecycle state does not allow this transition (`trust review status forbidden`).",
      "action": "Read the Trust review with `trust_review.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Trust review's current status permits. The reference itself is still valid, so no new Trust review is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_subject_control_type_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review subject accepts (`trust review subject control type unsupported`).",
      "action": "Replace the rejected value with one this Trust Review subject allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review subject, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_subject_entity_required",
      "httpStatus": 400,
      "cause": "The operation cannot run against this Trust Review subject until the `trust review subject entity required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Trust Review subject, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Trust Review subject names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_subject_not_found",
      "httpStatus": 404,
      "cause": "No Trust Review subject matches the `trustReviewSubjectId` this request referenced (`trust review subject not found`).",
      "action": "List Trust Review subjects in the same tenant, product, and environment, then retry with the `trustReviewSubjectId` that read returns.",
      "remediation": "Create or select the Trust Review subject in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_subject_ownership_percentage_invalid",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review subject accepts (`trust review subject ownership percentage invalid`).",
      "action": "Replace the rejected value with one this Trust Review subject allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review subject, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_subject_role_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review subject accepts (`trust review subject role unsupported`).",
      "action": "Replace the rejected value with one this Trust Review subject allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review subject, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_subject_status_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust Review subject accepts (`trust review subject status unsupported`).",
      "action": "Replace the rejected value with one this Trust Review subject allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust Review subject, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_target_tenant_mismatch",
      "httpStatus": 403,
      "cause": "The request contradicts the Trust review the platform has already durably recorded (`trust review target tenant mismatch`).",
      "action": "Re-read the Trust review with `trust_review.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust review as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_target_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Trust review accepts (`trust review target unsupported`).",
      "action": "Replace the rejected value with one this Trust review allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Trust review, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "trust_review_workspace_mismatch",
      "httpStatus": 409,
      "cause": "The request contradicts the Trust review the platform has already durably recorded (`trust review workspace mismatch`).",
      "action": "Re-read the Trust review with `trust_review.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Trust review as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "unauthorized",
      "httpStatus": 403,
      "cause": "The request did not include a valid Hyperscale bearer credential for this environment.",
      "action": "Authenticate with a product API key for REST/OpenAPI, SDK, or MCP calls, or use a current portal session for browser calls.",
      "remediation": "Sign in, create a product, create a sandbox API key, set HYPERSCALE_API_KEY, and retry with Authorization: Bearer <key>.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "usage_source_conflict",
      "httpStatus": 409,
      "cause": "The request contradicts the resource the platform has already durably recorded (`usage source conflict`).",
      "action": "Re-read the resource this request referenced and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the resource as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "validation_failed",
      "httpStatus": 400,
      "cause": "The submitted input did not match the expected form.",
      "action": "Fix missing, malformed, or out-of-range fields reported in the error details.",
      "remediation": "Use the SDK types, examples, and API reference to rebuild the request.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "webhook_endpoint_lifecycle_status_forbidden",
      "httpStatus": 409,
      "cause": "The Webhook endpoint's current lifecycle state does not allow this transition (`webhook endpoint lifecycle status forbidden`).",
      "action": "Read the Webhook endpoint with `webhook_endpoint.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Webhook endpoint's current status permits. The reference itself is still valid, so no new Webhook endpoint is needed.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_build_not_found",
      "httpStatus": 404,
      "cause": "No Product matches the `workspaceId` this request referenced (`workspace build not found`).",
      "action": "List Products in the same tenant, product, and environment, then retry with the `workspaceId` that read returns.",
      "remediation": "Create or select the Product in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_context_forbidden",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Product accepts (`workspace context forbidden`).",
      "action": "Replace the rejected value with one this Product allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Product, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_context_mismatch",
      "httpStatus": 400,
      "cause": "The request contradicts the Product the platform has already durably recorded (`workspace context mismatch`).",
      "action": "Re-read the Product with `product.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Product as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_context_owner_mismatch",
      "httpStatus": 400,
      "cause": "The request contradicts the Product the platform has already durably recorded (`workspace context owner mismatch`).",
      "action": "Re-read the Product with `product.retrieve` and compare the submitted ids, currency, product, tenant, and expected state against what comes back.",
      "remediation": "Rebuild the request from the Product as it now stands, then retry under a NEW idempotency key -- reuse the original key only when you are deliberately replaying the original mutation.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_context_required",
      "httpStatus": 400,
      "cause": "The operation cannot run against this Product until the `workspace context required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Product, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Product names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_not_found",
      "httpStatus": 404,
      "cause": "No Product matches the `workspaceId` this request referenced (`workspace not found`).",
      "action": "List Products in the same tenant, product, and environment, then retry with the `workspaceId` that read returns.",
      "remediation": "Create or select the Product in the environment the call runs against; ids never carry across tenants, or across sandbox and live.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_scope_required",
      "httpStatus": 400,
      "cause": "The operation cannot run against this Product until the `workspace scope required` prerequisite exists.",
      "action": "Supply the field, capability, evidence, or configuration the error details name for this Product, then call the operation again.",
      "remediation": "Complete the prerequisite through the surface that owns it -- the operation reference for this Product names it -- and the same call then succeeds unchanged.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_scope_unsupported",
      "httpStatus": 400,
      "cause": "The submitted value is not one this Product accepts (`workspace scope unsupported`).",
      "action": "Replace the rejected value with one this Product allows, as listed in the API reference or set by product policy.",
      "remediation": "Rebuild the request from the generated SDK types for this Product, which carry the allowed values as unions rather than free strings.",
      "retryable": false,
      "idempotencySafe": true
    },
    {
      "code": "workspace_status_forbidden",
      "httpStatus": 403,
      "cause": "The Product's current lifecycle state does not allow this transition (`workspace status forbidden`).",
      "action": "Read the Product with `product.retrieve` and pick the lifecycle operation its current status allows.",
      "remediation": "Apply a transition the Product's current status permits. The reference itself is still valid, so no new Product is needed.",
      "retryable": false,
      "idempotencySafe": true
    }
  ],
  "x-hyperscale-structural-errors": [
    "csrf_token_invalid",
    "idempotency_conflict",
    "idempotency_required",
    "internal_error",
    "invalid_request",
    "missing_required_permission",
    "missing_required_scope",
    "missing_required_workspace_capability",
    "not_found",
    "operation_not_allowed",
    "product_access_suspended",
    "product_activation_required",
    "rate_limited",
    "request_body_too_large",
    "resource_not_found",
    "resource_reader_unavailable",
    "state_conflict",
    "state_constraint_failed",
    "system_principal_required",
    "tenant_mismatch",
    "tenant_not_found",
    "unauthorized",
    "validation_failed"
  ],
  "x-hyperscale-blueprints": [
    {
      "id": "air-travel-agency",
      "name": "Air Travel Agency",
      "thesis": "A founder gets the settlement spine of a flight seller -- held bookings, carrier-decided confirmations, deadline-driven expiry, and quoted cancellations -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "air_travel",
      "templateComposition": [
        "air_travel"
      ],
      "sdkNamespace": "blueprints.airTravelAgency",
      "customNouns": [
        {
          "id": "itinerary",
          "name": "Itinerary"
        },
        {
          "id": "booking_hold",
          "name": "Booking hold"
        },
        {
          "id": "fare_settlement",
          "name": "Fare settlement"
        },
        {
          "id": "cancellation_quote",
          "name": "Cancellation quote"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerItinerary",
          "operation": "subject.create",
          "summary": "Register the flight itinerary a booking will purchase."
        },
        {
          "alias": "holdBooking",
          "operation": "flight_booking.create",
          "summary": "Hold a flight booking against its itinerary with no money moved."
        },
        {
          "alias": "confirmBooking",
          "operation": "flight_booking.confirm",
          "summary": "Confirm the booking through the carrier decision and settle the fare."
        },
        {
          "alias": "quoteCancellation",
          "operation": "flight_booking.cancel_quote",
          "summary": "Quote the refund under the void-window penalty schedule."
        },
        {
          "alias": "confirmCancellation",
          "operation": "flight_booking.cancel_confirm",
          "summary": "Execute the quoted cancellation refund to the traveler."
        }
      ],
      "providerFamilies": [
        {
          "id": "air_carrier",
          "name": "Air Carrier",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "b2b-trade-credit",
      "name": "B2B Trade Credit",
      "thesis": "A founder gets the settlement spine of a trade-credit operation -- counterparty limits, financed terms invoices, dated delinquency, and a collections trail -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "credit",
      "templateComposition": [
        "credit"
      ],
      "sdkNamespace": "blueprints.b2bTradeCredit",
      "customNouns": [
        {
          "id": "trade_limit",
          "name": "Trade limit"
        },
        {
          "id": "terms_invoice",
          "name": "Terms invoice"
        },
        {
          "id": "terms_payment",
          "name": "Terms payment"
        },
        {
          "id": "recovery_case",
          "name": "Recovery case"
        },
        {
          "id": "supplier_advance",
          "name": "Supplier advance"
        }
      ],
      "functionAliases": [
        {
          "alias": "approveTradeLimit",
          "operation": "exposure_arrangement.approve",
          "summary": "Approve the buyer's limit so invoices can be admitted under it."
        },
        {
          "alias": "invoiceOnTerms",
          "operation": "credit_agreement.create",
          "summary": "Open a terms invoice for a shipment under the buyer's limit."
        },
        {
          "alias": "advanceInvoice",
          "operation": "credit_agreement.advance",
          "summary": "Advance the invoice principal to the supplier at shipment."
        },
        {
          "alias": "settleInvoice",
          "operation": "credit_agreement.settle",
          "summary": "Settle the invoice once collected payments cover the principal."
        },
        {
          "alias": "closeTradeLimit",
          "operation": "exposure_arrangement.close",
          "summary": "Close a buyer's limit when the trading relationship ends."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "b2b-wholesale-marketplace",
      "name": "B2B Wholesale Marketplace",
      "thesis": "A founder gets the full settlement spine of a wholesale marketplace -- supplier catalogs, purchase-order escrow, trade-terms approval, shipment evidence, and supplier payouts -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "marketplace",
      "templateComposition": [
        "marketplace",
        "escrow",
        "payments_payouts"
      ],
      "sdkNamespace": "blueprints.b2bWholesaleMarketplace",
      "customNouns": [
        {
          "id": "wholesale_buyer",
          "name": "Wholesale buyer"
        },
        {
          "id": "supplier_catalog_item",
          "name": "Supplier catalog item"
        },
        {
          "id": "purchase_order",
          "name": "Purchase order"
        },
        {
          "id": "trade_terms",
          "name": "Trade terms"
        },
        {
          "id": "shipment_evidence",
          "name": "Shipment evidence"
        },
        {
          "id": "supplier_payout",
          "name": "Supplier payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "createWholesaleOrder",
          "operation": "escrow_order.create",
          "summary": "Open a purchase order for a buyer against supplier catalog items."
        },
        {
          "alias": "approveTradeTerms",
          "operation": "trust_requirement.respond",
          "summary": "Respond to the order's trade-terms requirement with agreed terms."
        },
        {
          "alias": "publishSupplierCatalogItem",
          "operation": "listing.create",
          "summary": "Publish a wholesale product to the supplier catalog."
        },
        {
          "alias": "attachShipmentEvidence",
          "operation": "trust_evidence.attach",
          "summary": "Attach delivery evidence to the purchase order's trust file."
        },
        {
          "alias": "splitSupplierPayout",
          "operation": "escrow_order.release",
          "summary": "Release the escrowed purchase order to the supplier when the shipment lands."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "bnpl-checkout",
      "name": "BNPL Checkout",
      "thesis": "A founder gets the settlement spine of a BNPL company -- advanced principal, declared schedules, overdue tracking, and a collections trail -- as one composed product with its own vocabulary and SDK, without building a lending ledger.",
      "primaryTemplateId": "credit",
      "templateComposition": [
        "credit"
      ],
      "sdkNamespace": "blueprints.bnplCheckout",
      "customNouns": [
        {
          "id": "purchase_plan",
          "name": "Purchase plan"
        },
        {
          "id": "plan_payment",
          "name": "Plan payment"
        },
        {
          "id": "spending_limit",
          "name": "Spending limit"
        },
        {
          "id": "recovery_case",
          "name": "Recovery case"
        },
        {
          "id": "merchant_disbursement",
          "name": "Merchant disbursement"
        }
      ],
      "functionAliases": [
        {
          "alias": "openPurchasePlan",
          "operation": "credit_agreement.create",
          "summary": "Open a pay-later purchase plan for a shopper's checkout."
        },
        {
          "alias": "disbursePrincipal",
          "operation": "credit_agreement.advance",
          "summary": "Advance the purchase principal to the merchant from the funding pool."
        },
        {
          "alias": "schedulePayment",
          "operation": "installment.create",
          "summary": "Declare one repayment of the plan with its due date and amount."
        },
        {
          "alias": "settlePlan",
          "operation": "credit_agreement.settle",
          "summary": "Settle the plan once collected repayments cover the principal."
        },
        {
          "alias": "openRecoveryCase",
          "operation": "collections_case.create",
          "summary": "Hand a delinquent balance off to a collections case."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "closed-loop-wallet",
      "name": "Closed-Loop Wallet",
      "thesis": "A founder gets the settlement spine of a stored-value program -- provisioned member accounts, limit-admitted spends, guardian freeze, and honest cash-out -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "wallet",
      "templateComposition": [
        "wallet"
      ],
      "sdkNamespace": "blueprints.closedLoopWallet",
      "customNouns": [
        {
          "id": "member_balance",
          "name": "Member balance"
        },
        {
          "id": "balance_load",
          "name": "Balance load"
        },
        {
          "id": "member_spend",
          "name": "Member spend"
        }
      ],
      "functionAliases": [
        {
          "alias": "openMemberBalance",
          "operation": "wallet.create",
          "summary": "Provision a member's balance with its dedicated ledger account and declared limit."
        },
        {
          "alias": "activateMemberBalance",
          "operation": "wallet.activate",
          "summary": "Activate the balance so loads and spends are admitted."
        },
        {
          "alias": "loadBalance",
          "operation": "wallet.topup",
          "summary": "Load the balance from the member's funding source as a receipt-backed transfer."
        },
        {
          "alias": "recordSpend",
          "operation": "wallet_spend.create",
          "summary": "Record a spend against the balance, admitted under the declared limit."
        },
        {
          "alias": "postSpend",
          "operation": "wallet_spend.post",
          "summary": "Post the spend, settling it as a statement line."
        },
        {
          "alias": "refundSpend",
          "operation": "wallet_spend.refund",
          "summary": "Refund a posted spend back to the balance."
        },
        {
          "alias": "freezeBalance",
          "operation": "wallet.freeze",
          "summary": "Freeze the balance so no spend can move money."
        },
        {
          "alias": "withdrawBalance",
          "operation": "wallet.withdraw",
          "summary": "Withdraw the remaining balance back to the member honestly."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "creator-payouts-tax-docs",
      "name": "Creator Payouts & Tax Docs",
      "thesis": "A payouts founder gets creator onboarding, per-event earnings ledgers, beneficiary verification, creator payouts, and tax-document reviews as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "payments_payouts",
      "templateComposition": [
        "payments_payouts"
      ],
      "sdkNamespace": "blueprints.creatorPayoutsTaxDocs",
      "customNouns": [
        {
          "id": "creator_account",
          "name": "Creator account"
        },
        {
          "id": "earnings_event",
          "name": "Earnings event"
        },
        {
          "id": "creator_payout",
          "name": "Creator payout"
        },
        {
          "id": "tax_profile",
          "name": "Tax profile"
        },
        {
          "id": "withholding_rule",
          "name": "Withholding rule"
        },
        {
          "id": "payout_receipt",
          "name": "Payout receipt"
        }
      ],
      "functionAliases": [
        {
          "alias": "onboardCreator",
          "operation": "customer.create",
          "summary": "Onboard a creator as a payout-ready customer."
        },
        {
          "alias": "recordEarningsEvent",
          "operation": "internal_transfer.create",
          "summary": "Post one earnings event to the creator's ledger account."
        },
        {
          "alias": "createCreatorPayout",
          "operation": "payout.create",
          "summary": "Create a payout for a verified creator."
        },
        {
          "alias": "applyWithholdingRule",
          "operation": "trust_requirement.respond",
          "summary": "Respond to the creator's declared withholding requirement on the tax profile."
        }
      ],
      "providerFamilies": [
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "digital-savings-circles",
      "name": "Digital Savings Circles",
      "thesis": "A founder gets the settlement spine of a savings-circle platform -- formation, enrollment, collected contributions, and rotating pot payouts -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "wallet",
      "templateComposition": [
        "wallet"
      ],
      "sdkNamespace": "blueprints.digitalSavingsCircles",
      "customNouns": [
        {
          "id": "circle",
          "name": "Circle"
        },
        {
          "id": "circle_seat",
          "name": "Circle seat"
        },
        {
          "id": "member_balance",
          "name": "Member balance"
        },
        {
          "id": "pot_payout",
          "name": "Pot payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "formCircle",
          "operation": "savings_circle.create",
          "summary": "Form a circle with its declared contribution amount and rotation order."
        },
        {
          "alias": "joinCircle",
          "operation": "circle_membership.create",
          "summary": "Enroll a member into a seat in the forming circle."
        },
        {
          "alias": "completeCircle",
          "operation": "savings_circle.close",
          "summary": "Close the circle once the final rotation has paid out."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "dream-trip-packages",
      "name": "Dream Trip Packages",
      "thesis": "A founder gets a tour operator, an embedded insurer, and a consumer lender in one composed product -- all-or-nothing package confirmation over independent legs, same-trip protection, and installment financing -- with one vocabulary and SDK.",
      "primaryTemplateId": "commerce",
      "templateComposition": [
        "commerce",
        "air_travel",
        "lodging",
        "insurance",
        "credit"
      ],
      "sdkNamespace": "blueprints.dreamTripPackages",
      "customNouns": [
        {
          "id": "trip_package",
          "name": "Trip package"
        },
        {
          "id": "package_flight",
          "name": "Package flight"
        },
        {
          "id": "package_stay",
          "name": "Package stay"
        },
        {
          "id": "trip_protection",
          "name": "Trip protection"
        },
        {
          "id": "disruption_claim",
          "name": "Disruption claim"
        },
        {
          "id": "payment_plan",
          "name": "Payment plan"
        },
        {
          "id": "plan_installment",
          "name": "Plan installment"
        }
      ],
      "functionAliases": [
        {
          "alias": "draftPackage",
          "operation": "travel_package.create",
          "summary": "Draft the packaged trip the legs will attach to."
        },
        {
          "alias": "holdPackageFlight",
          "operation": "flight_booking.create",
          "summary": "Hold a flight leg inside the package."
        },
        {
          "alias": "holdPackageStay",
          "operation": "hotel_stay.create",
          "summary": "Hold a lodging leg inside the package."
        },
        {
          "alias": "confirmPackage",
          "operation": "travel_package.confirm",
          "summary": "Confirm the package once every leg has confirmed."
        },
        {
          "alias": "cancelPackage",
          "operation": "travel_package.cancel",
          "summary": "Cancel the package and cascade full refunds across its legs."
        },
        {
          "alias": "completeTrip",
          "operation": "travel_package.complete",
          "summary": "Complete the package after the trip runs."
        },
        {
          "alias": "bindTripProtection",
          "operation": "policy.bind",
          "summary": "Bind protection over the packaged trip."
        },
        {
          "alias": "fileDisruptionClaim",
          "operation": "claim.create",
          "summary": "File a covered disruption against the trip protection."
        },
        {
          "alias": "openPaymentPlan",
          "operation": "credit_agreement.create",
          "summary": "Open installment financing for the packaged trip."
        },
        {
          "alias": "scheduleInstallment",
          "operation": "installment.create",
          "summary": "Schedule one repayment of the payment plan."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "air_carrier",
          "name": "Air Carrier",
          "status": "roadmap"
        },
        {
          "id": "lodging_supplier",
          "name": "Lodging Supplier",
          "status": "roadmap"
        },
        {
          "id": "insurance_carrier",
          "name": "Insurance Carrier",
          "status": "roadmap"
        },
        {
          "id": "insurance_claims_adjuster",
          "name": "Insurance Claims Adjuster",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "embedded-asset-protection",
      "name": "Embedded Asset Protection",
      "thesis": "A founder gets an embedded-protection program -- registered assets, bound coverage certificates, evidence-backed incident claims, and replacement payouts -- as one composed product speaking the protection trade's language.",
      "primaryTemplateId": "insurance",
      "templateComposition": [
        "insurance",
        "commerce"
      ],
      "sdkNamespace": "blueprints.embeddedAssetProtection",
      "customNouns": [
        {
          "id": "protected_asset",
          "name": "Protected asset"
        },
        {
          "id": "coverage_certificate",
          "name": "Coverage certificate"
        },
        {
          "id": "incident_report",
          "name": "Incident report"
        },
        {
          "id": "repair_estimate",
          "name": "Repair estimate"
        },
        {
          "id": "replacement_payout",
          "name": "Replacement payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerProtectedAsset",
          "operation": "subject.create",
          "summary": "Register a covered item as a protected asset."
        },
        {
          "alias": "attachAssetCoverage",
          "operation": "policy.bind",
          "summary": "Bind a coverage certificate against a protected asset."
        },
        {
          "alias": "submitIncidentReport",
          "operation": "claim.create",
          "summary": "Open a claim from a customer's incident report."
        },
        {
          "alias": "uploadRepairEstimate",
          "operation": "trust_evidence.attach",
          "summary": "Attach the repairer's costed estimate to the claim's trust file."
        },
        {
          "alias": "approveReplacementPayout",
          "operation": "claim.pay",
          "summary": "Settle the approved claim as a replacement payout."
        }
      ],
      "providerFamilies": [
        {
          "id": "insurance_carrier",
          "name": "Insurance Carrier",
          "status": "roadmap"
        },
        {
          "id": "insurance_claims_adjuster",
          "name": "Insurance Claims Adjuster",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "escrow_marketplace_sandbox",
      "name": "Escrow Marketplace Sandbox",
      "thesis": "The reference escrow marketplace: the archetype demo every escrow-family showcase specializes.",
      "primaryTemplateId": "escrow",
      "templateComposition": [
        "escrow",
        "marketplace"
      ],
      "sdkNamespace": "blueprints.escrowMarketplaceSandbox",
      "customNouns": [],
      "functionAliases": [],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        }
      ]
    },
    {
      "id": "fractional-art-shares",
      "name": "Fractional Art Shares",
      "thesis": "A founder gets a gallery, an escrow agent, and a transfer registrar in one composed product -- provenance-backed artworks, per-investor escrowed subscriptions, and a sale that settles each one on the ledger -- with one vocabulary and SDK.",
      "primaryTemplateId": "marketplace",
      "templateComposition": [
        "marketplace",
        "escrow",
        "payments_payouts"
      ],
      "sdkNamespace": "blueprints.fractionalArtShares",
      "customNouns": [
        {
          "id": "artwork",
          "name": "Artwork"
        },
        {
          "id": "share_offering",
          "name": "Share offering"
        },
        {
          "id": "share_subscription",
          "name": "Share subscription"
        },
        {
          "id": "provenance_record",
          "name": "Provenance record"
        },
        {
          "id": "liquidation_distribution",
          "name": "Liquidation distribution"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerArtwork",
          "operation": "subject.create",
          "summary": "Register the artwork an offering will fractionalize."
        },
        {
          "alias": "attachProvenance",
          "operation": "trust_evidence.attach",
          "summary": "Attach authenticity and ownership evidence to the artwork."
        },
        {
          "alias": "openShareOffering",
          "operation": "listing.create",
          "summary": "Open a subscription round over the registered artwork with its target and unit supply."
        },
        {
          "alias": "subscribeShares",
          "operation": "escrow_order.create",
          "summary": "Escrow an investor's unit purchase while the offering is open."
        },
        {
          "alias": "liquidateArtwork",
          "operation": "listing.sell",
          "summary": "Mark the artwork sold and close the offering to new subscriptions."
        },
        {
          "alias": "settleOffering",
          "operation": "escrow_order.release",
          "summary": "Release an escrowed subscription to the seller once the artwork is sold."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "hotel-booking-platform",
      "name": "Hotel Booking Platform",
      "thesis": "A founder gets the settlement spine of a lodging marketplace -- held stays, supplier-decided confirmations, deadline-driven expiry, and quoted cancellations -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "lodging",
      "templateComposition": [
        "lodging"
      ],
      "sdkNamespace": "blueprints.hotelBookingPlatform",
      "customNouns": [
        {
          "id": "stay_record",
          "name": "Stay record"
        },
        {
          "id": "stay_hold",
          "name": "Stay hold"
        },
        {
          "id": "rate_settlement",
          "name": "Rate settlement"
        },
        {
          "id": "cancellation_quote",
          "name": "Cancellation quote"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerStay",
          "operation": "subject.create",
          "summary": "Register the lodging stay a booking will purchase."
        },
        {
          "alias": "holdStay",
          "operation": "hotel_stay.create",
          "summary": "Hold a hotel stay against its property with no money moved."
        },
        {
          "alias": "confirmStay",
          "operation": "hotel_stay.confirm",
          "summary": "Confirm the stay through the supplier decision and settle the rate."
        },
        {
          "alias": "quoteCancellation",
          "operation": "hotel_stay.cancel_quote",
          "summary": "Quote the refund under the free-cancel penalty schedule."
        },
        {
          "alias": "confirmCancellation",
          "operation": "hotel_stay.cancel_confirm",
          "summary": "Execute the quoted cancellation refund to the guest."
        }
      ],
      "providerFamilies": [
        {
          "id": "lodging_supplier",
          "name": "Lodging Supplier",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "insured-travel-marketplace",
      "name": "Insured Travel Marketplace",
      "thesis": "A founder gets a travel seller and an embedded insurer in one composed product -- independent bookings, same-subject trip protection, carrier- and supplier-decided confirmations, and claim settlement -- with one vocabulary and SDK.",
      "primaryTemplateId": "air_travel",
      "templateComposition": [
        "air_travel",
        "lodging",
        "insurance"
      ],
      "sdkNamespace": "blueprints.insuredTravelMarketplace",
      "customNouns": [
        {
          "id": "trip_subject",
          "name": "Trip subject"
        },
        {
          "id": "travel_policy",
          "name": "Travel policy"
        },
        {
          "id": "covered_event",
          "name": "Covered event"
        },
        {
          "id": "protection_payout",
          "name": "Protection payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerTripSubject",
          "operation": "subject.create",
          "summary": "Register the itinerary or stay a booking and policy will share."
        },
        {
          "alias": "holdFlight",
          "operation": "flight_booking.create",
          "summary": "Hold a flight booking against the registered trip subject."
        },
        {
          "alias": "holdStay",
          "operation": "hotel_stay.create",
          "summary": "Hold a hotel stay against the registered trip subject."
        },
        {
          "alias": "bindTripProtection",
          "operation": "policy.bind",
          "summary": "Bind trip protection over the same subject the booking holds."
        },
        {
          "alias": "fileCoveredEvent",
          "operation": "claim.create",
          "summary": "File a disruption claim against the travel policy."
        },
        {
          "alias": "payProtection",
          "operation": "claim.pay",
          "summary": "Settle the approved disruption claim to the traveler."
        }
      ],
      "providerFamilies": [
        {
          "id": "air_carrier",
          "name": "Air Carrier",
          "status": "roadmap"
        },
        {
          "id": "lodging_supplier",
          "name": "Lodging Supplier",
          "status": "roadmap"
        },
        {
          "id": "insurance_carrier",
          "name": "Insurance Carrier",
          "status": "roadmap"
        },
        {
          "id": "insurance_claims_adjuster",
          "name": "Insurance Claims Adjuster",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "local-services-marketplace",
      "name": "Local Services Marketplace",
      "thesis": "A founder gets the whole job-settlement spine of a services marketplace -- service requests, provider offers, customer holds, completion evidence, and provider payouts -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "marketplace",
      "templateComposition": [
        "marketplace",
        "escrow"
      ],
      "sdkNamespace": "blueprints.localServicesMarketplace",
      "customNouns": [
        {
          "id": "service_request",
          "name": "Service request"
        },
        {
          "id": "provider_offer",
          "name": "Provider offer"
        },
        {
          "id": "customer_hold",
          "name": "Customer hold"
        },
        {
          "id": "completion_evidence",
          "name": "Completion evidence"
        },
        {
          "id": "provider_payout",
          "name": "Provider payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "postServiceRequest",
          "operation": "listing.create",
          "summary": "Post a customer's job as an open service request."
        },
        {
          "alias": "acceptProviderOffer",
          "operation": "listing.reserve",
          "summary": "Reserve the service request under an accepted provider offer."
        },
        {
          "alias": "fundServiceHold",
          "operation": "escrow_order.fund",
          "summary": "Fund the customer's escrow hold for an accepted job."
        },
        {
          "alias": "submitCompletionEvidence",
          "operation": "trust_evidence.attach",
          "summary": "Attach proof-of-work evidence to the job's trust file."
        },
        {
          "alias": "releaseProviderPayout",
          "operation": "escrow_order.release",
          "summary": "Release the customer hold to the provider once completion evidence lands."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "luxury-goods-consignment-escrow",
      "name": "Luxury Goods Consignment Escrow",
      "thesis": "A consignment founder gets registered assets, authenticity evidence, escrowed buyer holds, dispute claims, and consignor payouts as one composed product speaking the consignment trade's own language.",
      "primaryTemplateId": "escrow",
      "templateComposition": [
        "escrow",
        "marketplace",
        "insurance"
      ],
      "sdkNamespace": "blueprints.luxuryGoodsConsignmentEscrow",
      "customNouns": [
        {
          "id": "consigned_asset",
          "name": "Consigned asset"
        },
        {
          "id": "authenticity_check",
          "name": "Authenticity check"
        },
        {
          "id": "condition_report",
          "name": "Condition report"
        },
        {
          "id": "buyer_hold",
          "name": "Buyer hold"
        },
        {
          "id": "dispute_claim",
          "name": "Dispute claim"
        },
        {
          "id": "consignor_payout",
          "name": "Consignor payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerConsignedAsset",
          "operation": "listing.create",
          "summary": "Register a consigned asset for sale."
        },
        {
          "alias": "requestAuthenticityCheck",
          "operation": "trust_evidence.attach",
          "summary": "Attach expert authentication evidence to the asset."
        },
        {
          "alias": "placeBuyerHold",
          "operation": "escrow_order.fund",
          "summary": "Fund the buyer's escrow hold for an asset purchase."
        },
        {
          "alias": "openConditionDispute",
          "operation": "claim.create",
          "summary": "Open a condition dispute against the sale's protection coverage."
        },
        {
          "alias": "releaseConsignorPayout",
          "operation": "escrow_order.release",
          "summary": "Release the buyer's hold to the consignor when the sale completes clean."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "insurance_carrier",
          "name": "Insurance Carrier",
          "status": "roadmap"
        },
        {
          "id": "insurance_claims_adjuster",
          "name": "Insurance Claims Adjuster",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "parametric-travel-insurance",
      "name": "Parametric Travel Insurance",
      "thesis": "A founder gets the settlement spine of a parametric insurer -- bound travel policies, covered trips, recorded delay signals, and rule-driven beneficiary payouts -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "insurance",
      "templateComposition": [
        "insurance"
      ],
      "sdkNamespace": "blueprints.parametricTravelInsurance",
      "customNouns": [
        {
          "id": "travel_policy",
          "name": "Travel policy"
        },
        {
          "id": "covered_event",
          "name": "Covered event"
        },
        {
          "id": "delay_signal",
          "name": "Delay signal"
        },
        {
          "id": "payout_rule",
          "name": "Payout rule"
        },
        {
          "id": "beneficiary_payout",
          "name": "Beneficiary payout"
        }
      ],
      "functionAliases": [
        {
          "alias": "registerCoveredEvent",
          "operation": "subject.create",
          "summary": "Register the trip a policy will cover."
        },
        {
          "alias": "bindTravelPolicy",
          "operation": "policy.bind",
          "summary": "Bind a quoted travel policy against its covered trip."
        },
        {
          "alias": "triggerParametricClaim",
          "operation": "claim.create",
          "summary": "Open a claim when a recorded delay signal meets the payout rule."
        },
        {
          "alias": "payBeneficiary",
          "operation": "claim.pay",
          "summary": "Settle the triggered claim as a beneficiary payout."
        }
      ],
      "providerFamilies": [
        {
          "id": "insurance_carrier",
          "name": "Insurance Carrier",
          "status": "roadmap"
        },
        {
          "id": "insurance_claims_adjuster",
          "name": "Insurance Claims Adjuster",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "peer-lending-marketplace",
      "name": "Peer Lending Marketplace",
      "thesis": "A founder gets a lending marketplace and a loan servicer in one composed product -- escrowed lender commitments, one servicing account wired through the whole loan, weight-exact lender distributions, and a real recovery lane -- with one vocabulary and SDK.",
      "primaryTemplateId": "credit",
      "templateComposition": [
        "credit",
        "marketplace",
        "payments_payouts"
      ],
      "sdkNamespace": "blueprints.peerLendingMarketplace",
      "customNouns": [
        {
          "id": "loan_request",
          "name": "Loan request"
        },
        {
          "id": "lender_commitment",
          "name": "Lender commitment"
        },
        {
          "id": "loan",
          "name": "Loan"
        },
        {
          "id": "repayment",
          "name": "Repayment"
        },
        {
          "id": "lender_share",
          "name": "Lender share"
        },
        {
          "id": "recovery_case",
          "name": "Recovery case"
        },
        {
          "id": "outreach_record",
          "name": "Outreach record"
        }
      ],
      "functionAliases": [
        {
          "alias": "openLoanRequest",
          "operation": "funding_round.create",
          "summary": "Open the borrower's raise lenders will commit into."
        },
        {
          "alias": "commitFunds",
          "operation": "funding_commitment.create",
          "summary": "Escrow a lender's pledge while the round is open."
        },
        {
          "alias": "openLoan",
          "operation": "credit_agreement.create",
          "summary": "Open the loan agreement over the funded round's servicing account."
        },
        {
          "alias": "disburseLoan",
          "operation": "credit_agreement.advance",
          "summary": "Advance the funded principal to the borrower."
        },
        {
          "alias": "scheduleRepayment",
          "operation": "installment.create",
          "summary": "Schedule one repayment against the servicing account."
        },
        {
          "alias": "claimLenderShare",
          "operation": "lender_distribution.create",
          "summary": "Record a lender's claim on the serviced loan at origination."
        },
        {
          "alias": "settleLoan",
          "operation": "credit_agreement.settle",
          "summary": "Settle the loan after the last repayment collects."
        },
        {
          "alias": "openRecoveryCase",
          "operation": "collections_case.create",
          "summary": "Open a recovery case over a delinquent repayment."
        },
        {
          "alias": "logOutreach",
          "operation": "contact_attempt.create",
          "summary": "Log a borrower contact inside the recovery case."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "personalized-shopping-concierge",
      "name": "Personalized Shopping Concierge",
      "thesis": "A concierge founder gets shopper profiles, proposed merchant orders, approval-gated purchase holds, return windows, and store credit as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "commerce",
      "templateComposition": [
        "commerce",
        "marketplace",
        "escrow"
      ],
      "sdkNamespace": "blueprints.personalizedShoppingConcierge",
      "customNouns": [
        {
          "id": "shopper_profile",
          "name": "Shopper profile"
        },
        {
          "id": "concierge_recommendation",
          "name": "Concierge recommendation"
        },
        {
          "id": "purchase_approval",
          "name": "Purchase approval"
        },
        {
          "id": "merchant_order",
          "name": "Merchant order"
        },
        {
          "id": "return_window",
          "name": "Return window"
        },
        {
          "id": "store_credit",
          "name": "Store credit"
        }
      ],
      "functionAliases": [
        {
          "alias": "createShopperProfile",
          "operation": "customer.create",
          "summary": "Onboard a shopper with the profile the concierge buys for."
        },
        {
          "alias": "proposeRecommendation",
          "operation": "listing.create",
          "summary": "Propose a purchase recommendation for the shopper's approval."
        },
        {
          "alias": "approvePurchase",
          "operation": "escrow_order.fund",
          "summary": "Fund the shopper's approval hold for a proposed purchase."
        },
        {
          "alias": "attachMerchantOrder",
          "operation": "listing.update",
          "summary": "Attach the placed merchant order to an approved recommendation."
        },
        {
          "alias": "completeMerchantOrder",
          "operation": "listing.sell",
          "summary": "Complete the merchant order once the item is delivered."
        },
        {
          "alias": "issueStoreCredit",
          "operation": "internal_transfer.create",
          "summary": "Credit the shopper's store-credit account."
        },
        {
          "alias": "refundReturnWindow",
          "operation": "escrow_order.refund",
          "summary": "Refund the purchase hold when a return lands inside the window."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "smb-expense-card",
      "name": "SMB Expense Card",
      "thesis": "A founder gets an expense program's operating spine -- funded business accounts, cardholders, spend policies, authorization review, and a reimbursement ledger -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "wallet_cards",
      "templateComposition": [
        "wallet_cards"
      ],
      "sdkNamespace": "blueprints.smbExpenseCard",
      "customNouns": [
        {
          "id": "business_account",
          "name": "Business account"
        },
        {
          "id": "expense_card",
          "name": "Expense card"
        },
        {
          "id": "spend_policy",
          "name": "Spend policy"
        },
        {
          "id": "authorization_decision",
          "name": "Authorization decision"
        },
        {
          "id": "expense_receipt",
          "name": "Expense receipt"
        },
        {
          "id": "reimbursement_ledger",
          "name": "Reimbursement ledger"
        }
      ],
      "functionAliases": [
        {
          "alias": "createBusinessAccount",
          "operation": "account.create",
          "summary": "Open the business's expense float account."
        },
        {
          "alias": "fundExpenseFloat",
          "operation": "sandbox.account.fund",
          "summary": "Fund the expense float in sandbox."
        },
        {
          "alias": "issueExpenseCard",
          "operation": "card.create",
          "summary": "Issue a virtual expense card against the business float."
        },
        {
          "alias": "setSpendPolicy",
          "operation": "card.update",
          "summary": "Update the expense card's declarative spend controls."
        },
        {
          "alias": "approveCardAuthorization",
          "operation": "card_authorization.approve",
          "summary": "Approve a card authorization through the provider decision seam."
        },
        {
          "alias": "moveReimbursement",
          "operation": "internal_transfer.create",
          "summary": "Pay back out-of-pocket employee spend from the float."
        },
        {
          "alias": "attachExpenseReceipt",
          "operation": "trust_evidence.attach",
          "summary": "Attach a cardholder's receipt as evidence behind a cleared spend or reimbursement."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "banking_or_card_issuing",
          "name": "Banking & Card Issuing",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "tuition-installment-academy",
      "name": "Tuition Installment Academy",
      "thesis": "A founder gets the settlement spine of a tuition-financing operation -- funded terms, family payment schedules, dated delinquency, and a collections trail -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "credit",
      "templateComposition": [
        "credit"
      ],
      "sdkNamespace": "blueprints.tuitionInstallmentAcademy",
      "customNouns": [
        {
          "id": "tuition_plan",
          "name": "Tuition plan"
        },
        {
          "id": "tuition_payment",
          "name": "Tuition payment"
        },
        {
          "id": "family_limit",
          "name": "Family limit"
        },
        {
          "id": "recovery_case",
          "name": "Recovery case"
        },
        {
          "id": "term_funding",
          "name": "Term funding"
        }
      ],
      "functionAliases": [
        {
          "alias": "openTuitionPlan",
          "operation": "credit_agreement.create",
          "summary": "Open a tuition plan for a student's term at enrollment."
        },
        {
          "alias": "fundTerm",
          "operation": "credit_agreement.advance",
          "summary": "Advance the full term fee to the academy's account."
        },
        {
          "alias": "scheduleTuitionPayment",
          "operation": "installment.create",
          "summary": "Declare one family payment with its due date and amount."
        },
        {
          "alias": "settleTuitionPlan",
          "operation": "credit_agreement.settle",
          "summary": "Settle the plan once collected payments cover the term fee."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "settlement_ingestion",
          "name": "Settlement Ingestion (pay-in)",
          "status": "integrated"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    },
    {
      "id": "vehicle-escrow-marketplace",
      "name": "Vehicle Escrow Marketplace",
      "thesis": "A founder gets the entire settlement spine of a vehicle marketplace -- listings, buyer deposits, inspection evidence, title-transfer gating, and seller payouts -- as one composed product with its own vocabulary and SDK.",
      "primaryTemplateId": "escrow",
      "templateComposition": [
        "escrow",
        "marketplace",
        "insurance"
      ],
      "sdkNamespace": "blueprints.vehicleEscrowMarketplace",
      "customNouns": [
        {
          "id": "vehicle_listing",
          "name": "Vehicle listing"
        },
        {
          "id": "buyer_deposit",
          "name": "Buyer deposit"
        },
        {
          "id": "motor_policy",
          "name": "Motor policy"
        },
        {
          "id": "inspection_report",
          "name": "Inspection report"
        },
        {
          "id": "title_transfer",
          "name": "Title transfer"
        },
        {
          "id": "seller_payout",
          "name": "Seller payout"
        },
        {
          "id": "delivery_confirmation",
          "name": "Delivery confirmation"
        }
      ],
      "functionAliases": [
        {
          "alias": "createVehicleListing",
          "operation": "vehicle_listing.create",
          "summary": "Publish a vehicle for sale as a marketplace listing."
        },
        {
          "alias": "holdBuyerDeposit",
          "operation": "vehicle_escrow.fund",
          "summary": "Fund the buyer's escrow deposit for a vehicle deal."
        },
        {
          "alias": "attachInspectionReport",
          "operation": "trust_evidence.attach",
          "summary": "Attach pre-sale inspection evidence to the deal's trust file."
        },
        {
          "alias": "approveTitleTransfer",
          "operation": "trust_requirement.respond",
          "summary": "Respond to the title-transfer requirement with registry evidence."
        },
        {
          "alias": "releaseSellerPayout",
          "operation": "vehicle_escrow.release",
          "summary": "Release the escrowed deposit to the seller once conditions resolve."
        },
        {
          "alias": "refundBuyerDeposit",
          "operation": "vehicle_escrow.confirm_cancel",
          "summary": "Refund the escrowed deposit to the buyer on a failed deal."
        }
      ],
      "providerFamilies": [
        {
          "id": "accounts_ledger_first_party",
          "name": "Accounts & Ledger (first-party)",
          "status": "first_party"
        },
        {
          "id": "identity_verification",
          "name": "Identity & Business Verification",
          "status": "integrated"
        },
        {
          "id": "insurance_carrier",
          "name": "Insurance Carrier",
          "status": "roadmap"
        },
        {
          "id": "insurance_claims_adjuster",
          "name": "Insurance Claims Adjuster",
          "status": "roadmap"
        },
        {
          "id": "payouts",
          "name": "Payouts (bank)",
          "status": "integrated"
        }
      ]
    }
  ],
  "x-hyperscale-openapi-basis": {
    "generator": "@hyperscale/compiler OpenAPI emitter from Hyperscale contract operations",
    "openapiVersion": "3.1.1",
    "jsonSchemaDialect": "https://spec.openapis.org/oas/3.1/dialect/base"
  },
  "info": {
    "title": "Hyperscale Product API",
    "version": "0.1.0",
    "description": "The frozen Hyperscale Product API for one composed company Build. The same operation contract generates this OpenAPI document, hosted MCP tools, SDKs, and Product docs. Operation contracts declare idempotency, receipts, and ledger-backed money movement. Hyperscale is an agent-native fintech infrastructure control plane, not a bank or money handler. No tenant is live, neither hosted estate is production, and no real bank connection exists. The REST API is URL-versioned under /v1; see https://hyperscale0.ai/docs/deprecation.md for the 180-day retirement policy and response headers.",
    "license": {
      "name": "Hyperscale Proprietary License",
      "identifier": "LicenseRef-Hyperscale-Proprietary"
    },
    "contact": {
      "name": "Hyperscale",
      "url": "https://hyperscale0.ai",
      "email": "support@hyperscale0.ai"
    }
  },
  "servers": [
    {
      "url": "https://hyperscale0.ai",
      "description": "Hyperscale API"
    }
  ],
  "tags": [
    {
      "name": "account",
      "description": "A Hyperscale Account: a first-party, ledger-backed balance held for a platform, Product, entity, customer, escrow, settlement, or suspense purpose. It is never an external bank account; external payability comes from a financial address attached to it."
    },
    {
      "name": "activity",
      "description": "Operations for Activity."
    },
    {
      "name": "beneficiary",
      "description": "A verified external payee money can leave to. Payouts and withdrawals refuse a beneficiary that is unverified or inactive, and verification records a confirmation-of-payee match grade."
    },
    {
      "name": "billing_adjustment",
      "description": "A credit or debit applied to a billing period outside normal metering: a goodwill credit, a correction, or a manual charge, carrying its own direction, amount, and approval state."
    },
    {
      "name": "billing_period",
      "description": "The billing window a Product's usage, charges, and invoice belong to. A period opens, accrues, then closes for invoicing; nothing is billed outside a period."
    },
    {
      "name": "billing_subscription",
      "description": "A Product's subscription inside one billing period: the plan it runs on, when it started, and when it was cancelled."
    },
    {
      "name": "blueprint",
      "description": "Operations for blueprint."
    },
    {
      "name": "charge",
      "description": "A single billable amount raised against a billing period, carrying the transfer it settled through once it has been paid."
    },
    {
      "name": "collection",
      "description": "The pay-in noun: money arriving from the outside world, tracked from the expected payment that declared it through to the account it credits."
    },
    {
      "name": "consent",
      "description": "Product-scoped customer consent for provider data-sharing. Provider-mediated sharing requires active, unexpired consent that covers the target provider and data categories."
    },
    {
      "name": "credit_balance",
      "description": "A customer's running credit position in one currency. Grants add to it, ledger entries move it, and invoices draw it down before charging."
    },
    {
      "name": "credit_grant",
      "description": "A block of credit issued to a customer, tracked from its original amount down to the amount still remaining as invoices consume it."
    },
    {
      "name": "credit_ledger_entry",
      "description": "One movement of credit: the grant it came from, the invoice that consumed it, the direction and amount, and the balance left after. These entries are the working behind every credit balance."
    },
    {
      "name": "credit_note",
      "description": "A document that reverses part or all of a finalized invoice. Issuing one never edits the invoice; it records the offsetting amount against it."
    },
    {
      "name": "credit_note_line",
      "description": "One line of a credit note, bound to the invoice line it reverses and carrying the amount reversed."
    },
    {
      "name": "customer",
      "description": "An end customer of a Product, the person or business a Team serves. Identity facts live on the linked entity; this row carries the Product-facing display name, external reference, and status."
    },
    {
      "name": "customer_access",
      "description": "The grant that lets one customer use one Product. The customer credential spans the company, so this row is what makes it usable on a specific Product."
    },
    {
      "name": "deposit",
      "description": "Money received from outside Hyperscale after it has been attributed to a financial address and account."
    },
    {
      "name": "developer_log",
      "description": "Operations for Developer log."
    },
    {
      "name": "event",
      "description": "Operations for Event."
    },
    {
      "name": "expected_payment",
      "description": "A declaration that money should arrive: the account and address it is due on, the amount and date windows it must fall inside, and the reference to match. Incoming credits are matched against it to close a collection."
    },
    {
      "name": "extension",
      "description": "Operations for extension."
    },
    {
      "name": "financial_address",
      "description": "An externally payable address (IBAN) attached to a Hyperscale Account. It is how outside money reaches that account, and it holds no balance of its own."
    },
    {
      "name": "internal_transfer",
      "description": "Money moving between two Hyperscale Accounts. It never crosses the provider boundary, and a reserved transfer holds the funds until it is posted or expires."
    },
    {
      "name": "invoice",
      "description": "The billed total for one billing period: the subtotal of its lines, the credit applied against it, and the amount owed. Finalizing an invoice freezes those numbers."
    },
    {
      "name": "invoice_line",
      "description": "One priced line of an invoice: the meter it came from, the quantity billed, the unit amount, and the resulting subtotal."
    },
    {
      "name": "kyc",
      "description": "Operations for kyc."
    },
    {
      "name": "meter_period_snapshot",
      "description": "One meter's quantity frozen for one billing period. Invoicing prices the snapshot rather than the live counter, so later usage can never change a closed bill."
    },
    {
      "name": "noun_instance",
      "description": "A blueprint-native business noun instance. Lifecycle status and captured operation refs live on the row; money truth stays on the underlying ledger operations."
    },
    {
      "name": "operation",
      "description": "One recorded execution of a contract operation: what ran, for which company, and how it ended. Receipts, audit events, and money movements all point back at the operation row that produced them."
    },
    {
      "name": "payout",
      "description": "Money leaving Hyperscale to an active beneficiary, with execution details hidden behind honest statuses and events."
    },
    {
      "name": "receipt",
      "description": "The durable proof that an operation completed: what ran, for which company, and the terminal outcome. An operation that promises a receipt is not finished until one exists."
    },
    {
      "name": "sandbox_account_funding",
      "description": "Operations for Sandbox account funding."
    },
    {
      "name": "subject",
      "description": "The thing a Product trades, protects, rents, or finances, with versioned attributes and one declared monetary value."
    },
    {
      "name": "trust_evidence",
      "description": "A document attached to a Trust Review, with its type, checksum, and size. Evidence lands pending review and satisfies nothing on its own; requirement responses cite it."
    },
    {
      "name": "trust_requirement",
      "description": "One named thing a Trust Review still needs before it can be decided. The platform records requirements during review, and the company answers each by citing evidence."
    },
    {
      "name": "trust_review",
      "description": "A risky action held for a decision: it pauses as a review and executes only once an approval is recorded. Going live is the review every company meets first."
    },
    {
      "name": "usage_record",
      "description": "One metered event: the meter, the quantity, and the operation that produced it. Usage records roll up into the period snapshot that gets priced."
    },
    {
      "name": "webhook_delivery",
      "description": "One attempt to deliver one event to one endpoint: the attempt number, the HTTP status, a snippet of the response, and when the next retry is due."
    },
    {
      "name": "webhook_endpoint",
      "description": "A URL a Product receives events on, with the event types it subscribes to, the last four characters of its signing secret, and the health of its most recent delivery."
    },
    {
      "name": "workspace",
      "description": "A Product: the composed or primitive surface a Team builds and sells on. It owns its capabilities, its API keys, its customers, and its billing."
    }
  ],
  "webhooks": {
    "account.closed": {
      "x-hyperscale-event-type": "account.closed",
      "x-hyperscale-operation": "account.close",
      "x-hyperscale-operation-id": "account_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_account_closed",
        "summary": "Receive account.closed events",
        "description": "Contract event payload projected from account.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "account.closed",
        "x-hyperscale-operation": "account.close",
        "x-hyperscale-operation-id": "account_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "account.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "account.created": {
      "x-hyperscale-event-type": "account.created",
      "x-hyperscale-operation": "account.create",
      "x-hyperscale-operation-id": "account_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_account_created",
        "summary": "Receive account.created events",
        "description": "Contract event payload projected from account.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "account.created",
        "x-hyperscale-operation": "account.create",
        "x-hyperscale-operation-id": "account_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "account.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "account.frozen": {
      "x-hyperscale-event-type": "account.frozen",
      "x-hyperscale-operation": "account.freeze",
      "x-hyperscale-operation-id": "account_freeze",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_account_frozen",
        "summary": "Receive account.frozen events",
        "description": "Contract event payload projected from account.freeze. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "account.frozen",
        "x-hyperscale-operation": "account.freeze",
        "x-hyperscale-operation-id": "account_freeze",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "account.frozen"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "account.unfrozen": {
      "x-hyperscale-event-type": "account.unfrozen",
      "x-hyperscale-operation": "account.unfreeze",
      "x-hyperscale-operation-id": "account_unfreeze",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_account_unfrozen",
        "summary": "Receive account.unfrozen events",
        "description": "Contract event payload projected from account.unfreeze. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "account.unfrozen",
        "x-hyperscale-operation": "account.unfreeze",
        "x-hyperscale-operation-id": "account_unfreeze",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "account.unfrozen"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "beneficiary.created": {
      "x-hyperscale-event-type": "beneficiary.created",
      "x-hyperscale-operation": "beneficiary.create",
      "x-hyperscale-operation-id": "beneficiary_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_beneficiary_created",
        "summary": "Receive beneficiary.created events",
        "description": "Contract event payload projected from beneficiary.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "beneficiary.created",
        "x-hyperscale-operation": "beneficiary.create",
        "x-hyperscale-operation-id": "beneficiary_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "beneficiary.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card.activated": {
      "x-hyperscale-event-type": "card.activated",
      "x-hyperscale-operation": "card.activate",
      "x-hyperscale-operation-id": "card_activate",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_activated",
        "summary": "Receive card.activated events",
        "description": "Contract event payload projected from card.activate. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card.activated",
        "x-hyperscale-operation": "card.activate",
        "x-hyperscale-operation-id": "card_activate",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card.activated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card.canceled": {
      "x-hyperscale-event-type": "card.canceled",
      "x-hyperscale-operation": "card.cancel",
      "x-hyperscale-operation-id": "card_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_canceled",
        "summary": "Receive card.canceled events",
        "description": "Contract event payload projected from card.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card.canceled",
        "x-hyperscale-operation": "card.cancel",
        "x-hyperscale-operation-id": "card_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card.freezed": {
      "x-hyperscale-event-type": "card.freezed",
      "x-hyperscale-operation": "card.freeze",
      "x-hyperscale-operation-id": "card_freeze",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_freezed",
        "summary": "Receive card.freezed events",
        "description": "Contract event payload projected from card.freeze. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card.freezed",
        "x-hyperscale-operation": "card.freeze",
        "x-hyperscale-operation-id": "card_freeze",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card.freezed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card.issued": {
      "x-hyperscale-event-type": "card.issued",
      "x-hyperscale-operation": "card.create",
      "x-hyperscale-operation-id": "card_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_issued",
        "summary": "Receive card.issued events",
        "description": "Contract event payload projected from card.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card.issued",
        "x-hyperscale-operation": "card.create",
        "x-hyperscale-operation-id": "card_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card.issued"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card.unfrozen": {
      "x-hyperscale-event-type": "card.unfrozen",
      "x-hyperscale-operation": "card.unfreeze",
      "x-hyperscale-operation-id": "card_unfreeze",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_unfrozen",
        "summary": "Receive card.unfrozen events",
        "description": "Contract event payload projected from card.unfreeze. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card.unfrozen",
        "x-hyperscale-operation": "card.unfreeze",
        "x-hyperscale-operation-id": "card_unfreeze",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card.unfrozen"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card.updated": {
      "x-hyperscale-event-type": "card.updated",
      "x-hyperscale-operation": "card.update",
      "x-hyperscale-operation-id": "card_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_updated",
        "summary": "Receive card.updated events",
        "description": "Contract event payload projected from card.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card.updated",
        "x-hyperscale-operation": "card.update",
        "x-hyperscale-operation-id": "card_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_authorization.approved": {
      "x-hyperscale-event-type": "card_authorization.approved",
      "x-hyperscale-operation": "card_authorization.approve",
      "x-hyperscale-operation-id": "card_authorization_approve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_authorization_approved",
        "summary": "Receive card_authorization.approved events",
        "description": "Contract event payload projected from card_authorization.approve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_authorization.approved",
        "x-hyperscale-operation": "card_authorization.approve",
        "x-hyperscale-operation-id": "card_authorization_approve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_authorization.approved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_authorization.captured": {
      "x-hyperscale-event-type": "card_authorization.captured",
      "x-hyperscale-operation": "card_authorization.capture",
      "x-hyperscale-operation-id": "card_authorization_capture",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_authorization_captured",
        "summary": "Receive card_authorization.captured events",
        "description": "Contract event payload projected from card_authorization.capture. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_authorization.captured",
        "x-hyperscale-operation": "card_authorization.capture",
        "x-hyperscale-operation-id": "card_authorization_capture",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_authorization.captured"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_authorization.declined": {
      "x-hyperscale-event-type": "card_authorization.declined",
      "x-hyperscale-operation": "card_authorization.decline",
      "x-hyperscale-operation-id": "card_authorization_decline",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_authorization_declined",
        "summary": "Receive card_authorization.declined events",
        "description": "Contract event payload projected from card_authorization.decline. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_authorization.declined",
        "x-hyperscale-operation": "card_authorization.decline",
        "x-hyperscale-operation-id": "card_authorization_decline",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_authorization.declined"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_authorization.requested": {
      "x-hyperscale-event-type": "card_authorization.requested",
      "x-hyperscale-operation": "card_authorization.create",
      "x-hyperscale-operation-id": "card_authorization_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_authorization_requested",
        "summary": "Receive card_authorization.requested events",
        "description": "Contract event payload projected from card_authorization.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_authorization.requested",
        "x-hyperscale-operation": "card_authorization.create",
        "x-hyperscale-operation-id": "card_authorization_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_authorization.requested"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_authorization.reversed": {
      "x-hyperscale-event-type": "card_authorization.reversed",
      "x-hyperscale-operation": "card_authorization.reverse",
      "x-hyperscale-operation-id": "card_authorization_reverse",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_authorization_reversed",
        "summary": "Receive card_authorization.reversed events",
        "description": "Contract event payload projected from card_authorization.reverse. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_authorization.reversed",
        "x-hyperscale-operation": "card_authorization.reverse",
        "x-hyperscale-operation-id": "card_authorization_reverse",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_authorization.reversed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_dispute.filed": {
      "x-hyperscale-event-type": "card_dispute.filed",
      "x-hyperscale-operation": "card_dispute.create",
      "x-hyperscale-operation-id": "card_dispute_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_dispute_filed",
        "summary": "Receive card_dispute.filed events",
        "description": "Contract event payload projected from card_dispute.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_dispute.filed",
        "x-hyperscale-operation": "card_dispute.create",
        "x-hyperscale-operation-id": "card_dispute_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_dispute.filed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_dispute.reviewed": {
      "x-hyperscale-event-type": "card_dispute.reviewed",
      "x-hyperscale-operation": "card_dispute.review",
      "x-hyperscale-operation-id": "card_dispute_review",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_dispute_reviewed",
        "summary": "Receive card_dispute.reviewed events",
        "description": "Contract event payload projected from card_dispute.review. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_dispute.reviewed",
        "x-hyperscale-operation": "card_dispute.review",
        "x-hyperscale-operation-id": "card_dispute_review",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_dispute.reviewed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_dispute.updated": {
      "x-hyperscale-event-type": "card_dispute.updated",
      "x-hyperscale-operation": "card_dispute.update",
      "x-hyperscale-operation-id": "card_dispute_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_dispute_updated",
        "summary": "Receive card_dispute.updated events",
        "description": "Contract event payload projected from card_dispute.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_dispute.updated",
        "x-hyperscale-operation": "card_dispute.update",
        "x-hyperscale-operation-id": "card_dispute_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_dispute.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_dispute.won": {
      "x-hyperscale-event-type": "card_dispute.won",
      "x-hyperscale-operation": "card_dispute.win",
      "x-hyperscale-operation-id": "card_dispute_win",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_dispute_won",
        "summary": "Receive card_dispute.won events",
        "description": "Contract event payload projected from card_dispute.win. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_dispute.won",
        "x-hyperscale-operation": "card_dispute.win",
        "x-hyperscale-operation-id": "card_dispute_win",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_dispute.won"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_transaction.posted": {
      "x-hyperscale-event-type": "card_transaction.posted",
      "x-hyperscale-operation": "card_transaction.create",
      "x-hyperscale-operation-id": "card_transaction_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_transaction_posted",
        "summary": "Receive card_transaction.posted events",
        "description": "Contract event payload projected from card_transaction.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_transaction.posted",
        "x-hyperscale-operation": "card_transaction.create",
        "x-hyperscale-operation-id": "card_transaction_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_transaction.posted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "card_transaction.refunded": {
      "x-hyperscale-event-type": "card_transaction.refunded",
      "x-hyperscale-operation": "card_transaction.refund",
      "x-hyperscale-operation-id": "card_transaction_refund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_card_transaction_refunded",
        "summary": "Receive card_transaction.refunded events",
        "description": "Contract event payload projected from card_transaction.refund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "card_transaction.refunded",
        "x-hyperscale-operation": "card_transaction.refund",
        "x-hyperscale-operation-id": "card_transaction_refund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "card_transaction.refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "cardholder.activated": {
      "x-hyperscale-event-type": "cardholder.activated",
      "x-hyperscale-operation": "cardholder.activate",
      "x-hyperscale-operation-id": "cardholder_activate",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_cardholder_activated",
        "summary": "Receive cardholder.activated events",
        "description": "Contract event payload projected from cardholder.activate. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "cardholder.activated",
        "x-hyperscale-operation": "cardholder.activate",
        "x-hyperscale-operation-id": "cardholder_activate",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "cardholder.activated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "cardholder.closed": {
      "x-hyperscale-event-type": "cardholder.closed",
      "x-hyperscale-operation": "cardholder.close",
      "x-hyperscale-operation-id": "cardholder_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_cardholder_closed",
        "summary": "Receive cardholder.closed events",
        "description": "Contract event payload projected from cardholder.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "cardholder.closed",
        "x-hyperscale-operation": "cardholder.close",
        "x-hyperscale-operation-id": "cardholder_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "cardholder.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "cardholder.created": {
      "x-hyperscale-event-type": "cardholder.created",
      "x-hyperscale-operation": "cardholder.create",
      "x-hyperscale-operation-id": "cardholder_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_cardholder_created",
        "summary": "Receive cardholder.created events",
        "description": "Contract event payload projected from cardholder.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "cardholder.created",
        "x-hyperscale-operation": "cardholder.create",
        "x-hyperscale-operation-id": "cardholder_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "cardholder.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "cardholder.resumed": {
      "x-hyperscale-event-type": "cardholder.resumed",
      "x-hyperscale-operation": "cardholder.resume",
      "x-hyperscale-operation-id": "cardholder_resume",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_cardholder_resumed",
        "summary": "Receive cardholder.resumed events",
        "description": "Contract event payload projected from cardholder.resume. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "cardholder.resumed",
        "x-hyperscale-operation": "cardholder.resume",
        "x-hyperscale-operation-id": "cardholder_resume",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "cardholder.resumed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "cardholder.suspended": {
      "x-hyperscale-event-type": "cardholder.suspended",
      "x-hyperscale-operation": "cardholder.suspend",
      "x-hyperscale-operation-id": "cardholder_suspend",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_cardholder_suspended",
        "summary": "Receive cardholder.suspended events",
        "description": "Contract event payload projected from cardholder.suspend. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "cardholder.suspended",
        "x-hyperscale-operation": "cardholder.suspend",
        "x-hyperscale-operation-id": "cardholder_suspend",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "cardholder.suspended"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "cardholder.updated": {
      "x-hyperscale-event-type": "cardholder.updated",
      "x-hyperscale-operation": "cardholder.update",
      "x-hyperscale-operation-id": "cardholder_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_cardholder_updated",
        "summary": "Receive cardholder.updated events",
        "description": "Contract event payload projected from cardholder.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "cardholder.updated",
        "x-hyperscale-operation": "cardholder.update",
        "x-hyperscale-operation-id": "cardholder_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "cardholder.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "circle_membership.created": {
      "x-hyperscale-event-type": "circle_membership.created",
      "x-hyperscale-operation": "circle_membership.create",
      "x-hyperscale-operation-id": "circle_membership_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_circle_membership_created",
        "summary": "Receive circle_membership.created events",
        "description": "Contract event payload projected from circle_membership.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "circle_membership.created",
        "x-hyperscale-operation": "circle_membership.create",
        "x-hyperscale-operation-id": "circle_membership_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "circle_membership.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.approved": {
      "x-hyperscale-event-type": "claim.approved",
      "x-hyperscale-operation": "claim.approve",
      "x-hyperscale-operation-id": "claim_approve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_approved",
        "summary": "Receive claim.approved events",
        "description": "Contract event payload projected from claim.approve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.approved",
        "x-hyperscale-operation": "claim.approve",
        "x-hyperscale-operation-id": "claim_approve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.approved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.assessed": {
      "x-hyperscale-event-type": "claim.assessed",
      "x-hyperscale-operation": "claim.assess",
      "x-hyperscale-operation-id": "claim_assess",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_assessed",
        "summary": "Receive claim.assessed events",
        "description": "Contract event payload projected from claim.assess. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.assessed",
        "x-hyperscale-operation": "claim.assess",
        "x-hyperscale-operation-id": "claim_assess",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.assessed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.attested": {
      "x-hyperscale-event-type": "claim.attested",
      "x-hyperscale-operation": "claim.attest",
      "x-hyperscale-operation-id": "claim_attest",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_attested",
        "summary": "Receive claim.attested events",
        "description": "Contract event payload projected from claim.attest. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.attested",
        "x-hyperscale-operation": "claim.attest",
        "x-hyperscale-operation-id": "claim_attest",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.attested"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.denied": {
      "x-hyperscale-event-type": "claim.denied",
      "x-hyperscale-operation": "claim.deny",
      "x-hyperscale-operation-id": "claim_deny",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_denied",
        "summary": "Receive claim.denied events",
        "description": "Contract event payload projected from claim.deny. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.denied",
        "x-hyperscale-operation": "claim.deny",
        "x-hyperscale-operation-id": "claim_deny",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.denied"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.filed": {
      "x-hyperscale-event-type": "claim.filed",
      "x-hyperscale-operation": "claim.create",
      "x-hyperscale-operation-id": "claim_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_filed",
        "summary": "Receive claim.filed events",
        "description": "Contract event payload projected from claim.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.filed",
        "x-hyperscale-operation": "claim.create",
        "x-hyperscale-operation-id": "claim_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.filed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.paid": {
      "x-hyperscale-event-type": "claim.paid",
      "x-hyperscale-operation": "claim.pay",
      "x-hyperscale-operation-id": "claim_pay",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_paid",
        "summary": "Receive claim.paid events",
        "description": "Contract event payload projected from claim.pay. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.paid",
        "x-hyperscale-operation": "claim.pay",
        "x-hyperscale-operation-id": "claim_pay",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.paid"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.reversed": {
      "x-hyperscale-event-type": "claim.reversed",
      "x-hyperscale-operation": "claim.reverse",
      "x-hyperscale-operation-id": "claim_reverse",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_reversed",
        "summary": "Receive claim.reversed events",
        "description": "Contract event payload projected from claim.reverse. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.reversed",
        "x-hyperscale-operation": "claim.reverse",
        "x-hyperscale-operation-id": "claim_reverse",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.reversed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "claim.updated": {
      "x-hyperscale-event-type": "claim.updated",
      "x-hyperscale-operation": "claim.update",
      "x-hyperscale-operation-id": "claim_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_claim_updated",
        "summary": "Receive claim.updated events",
        "description": "Contract event payload projected from claim.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "claim.updated",
        "x-hyperscale-operation": "claim.update",
        "x-hyperscale-operation-id": "claim_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "claim.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collection.pay_in.cancelled": {
      "x-hyperscale-event-type": "collection.pay_in.cancelled",
      "x-hyperscale-operation": "collection.pay_in.cancel",
      "x-hyperscale-operation-id": "collection_pay_in_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collection_pay_in_cancelled",
        "summary": "Receive collection.pay_in.cancelled events",
        "description": "Contract event payload projected from collection.pay_in.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collection.pay_in.cancelled",
        "x-hyperscale-operation": "collection.pay_in.cancel",
        "x-hyperscale-operation-id": "collection_pay_in_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collection.pay_in.cancelled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collection.pay_in.captured": {
      "x-hyperscale-event-type": "collection.pay_in.captured",
      "x-hyperscale-operation": "collection.pay_in.capture",
      "x-hyperscale-operation-id": "collection_pay_in_capture",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collection_pay_in_captured",
        "summary": "Receive collection.pay_in.captured events",
        "description": "Contract event payload projected from collection.pay_in.capture. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collection.pay_in.captured",
        "x-hyperscale-operation": "collection.pay_in.capture",
        "x-hyperscale-operation-id": "collection_pay_in_capture",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collection.pay_in.captured"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collection.pay_in.reserved": {
      "x-hyperscale-event-type": "collection.pay_in.reserved",
      "x-hyperscale-operation": "collection.pay_in.reserve",
      "x-hyperscale-operation-id": "collection_pay_in_reserve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collection_pay_in_reserved",
        "summary": "Receive collection.pay_in.reserved events",
        "description": "Contract event payload projected from collection.pay_in.reserve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collection.pay_in.reserved",
        "x-hyperscale-operation": "collection.pay_in.reserve",
        "x-hyperscale-operation-id": "collection_pay_in_reserve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collection.pay_in.reserved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.assigned": {
      "x-hyperscale-event-type": "collections_case.assigned",
      "x-hyperscale-operation": "collections_case.assign",
      "x-hyperscale-operation-id": "collections_case_assign",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_assigned",
        "summary": "Receive collections_case.assigned events",
        "description": "Contract event payload projected from collections_case.assign. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.assigned",
        "x-hyperscale-operation": "collections_case.assign",
        "x-hyperscale-operation-id": "collections_case_assign",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.assigned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.created": {
      "x-hyperscale-event-type": "collections_case.created",
      "x-hyperscale-operation": "collections_case.create",
      "x-hyperscale-operation-id": "collections_case_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_created",
        "summary": "Receive collections_case.created events",
        "description": "Contract event payload projected from collections_case.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.created",
        "x-hyperscale-operation": "collections_case.create",
        "x-hyperscale-operation-id": "collections_case_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.plan_agreed": {
      "x-hyperscale-event-type": "collections_case.plan_agreed",
      "x-hyperscale-operation": "collections_case.agree_plan",
      "x-hyperscale-operation-id": "collections_case_agree_plan",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_plan_agreed",
        "summary": "Receive collections_case.plan_agreed events",
        "description": "Contract event payload projected from collections_case.agree_plan. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.plan_agreed",
        "x-hyperscale-operation": "collections_case.agree_plan",
        "x-hyperscale-operation-id": "collections_case_agree_plan",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.plan_agreed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.recalled": {
      "x-hyperscale-event-type": "collections_case.recalled",
      "x-hyperscale-operation": "collections_case.recall",
      "x-hyperscale-operation-id": "collections_case_recall",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_recalled",
        "summary": "Receive collections_case.recalled events",
        "description": "Contract event payload projected from collections_case.recall. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.recalled",
        "x-hyperscale-operation": "collections_case.recall",
        "x-hyperscale-operation-id": "collections_case_recall",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.recalled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.recovered": {
      "x-hyperscale-event-type": "collections_case.recovered",
      "x-hyperscale-operation": "collections_case.recover",
      "x-hyperscale-operation-id": "collections_case_recover",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_recovered",
        "summary": "Receive collections_case.recovered events",
        "description": "Contract event payload projected from collections_case.recover. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.recovered",
        "x-hyperscale-operation": "collections_case.recover",
        "x-hyperscale-operation-id": "collections_case_recover",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.recovered"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.returned_uncollected": {
      "x-hyperscale-event-type": "collections_case.returned_uncollected",
      "x-hyperscale-operation": "collections_case.return_uncollected",
      "x-hyperscale-operation-id": "collections_case_return_uncollected",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_returned_uncollected",
        "summary": "Receive collections_case.returned_uncollected events",
        "description": "Contract event payload projected from collections_case.return_uncollected. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.returned_uncollected",
        "x-hyperscale-operation": "collections_case.return_uncollected",
        "x-hyperscale-operation-id": "collections_case_return_uncollected",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.returned_uncollected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "collections_case.updated": {
      "x-hyperscale-event-type": "collections_case.updated",
      "x-hyperscale-operation": "collections_case.update",
      "x-hyperscale-operation-id": "collections_case_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_collections_case_updated",
        "summary": "Receive collections_case.updated events",
        "description": "Contract event payload projected from collections_case.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "collections_case.updated",
        "x-hyperscale-operation": "collections_case.update",
        "x-hyperscale-operation-id": "collections_case_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "collections_case.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "consent.revoked": {
      "x-hyperscale-event-type": "consent.revoked",
      "x-hyperscale-operation": "consent.revoke",
      "x-hyperscale-operation-id": "consent_revoke",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_consent_revoked",
        "summary": "Receive consent.revoked events",
        "description": "Contract event payload projected from consent.revoke. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "consent.revoked",
        "x-hyperscale-operation": "consent.revoke",
        "x-hyperscale-operation-id": "consent_revoke",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "consent.revoked"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "contact_attempt.created": {
      "x-hyperscale-event-type": "contact_attempt.created",
      "x-hyperscale-operation": "contact_attempt.create",
      "x-hyperscale-operation-id": "contact_attempt_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_contact_attempt_created",
        "summary": "Receive contact_attempt.created events",
        "description": "Contract event payload projected from contact_attempt.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "contact_attempt.created",
        "x-hyperscale-operation": "contact_attempt.create",
        "x-hyperscale-operation-id": "contact_attempt_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "contact_attempt.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "contact_attempt.voided": {
      "x-hyperscale-event-type": "contact_attempt.voided",
      "x-hyperscale-operation": "contact_attempt.void",
      "x-hyperscale-operation-id": "contact_attempt_void",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_contact_attempt_voided",
        "summary": "Receive contact_attempt.voided events",
        "description": "Contract event payload projected from contact_attempt.void. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "contact_attempt.voided",
        "x-hyperscale-operation": "contact_attempt.void",
        "x-hyperscale-operation-id": "contact_attempt_void",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "contact_attempt.voided"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.advanced": {
      "x-hyperscale-event-type": "credit_agreement.advanced",
      "x-hyperscale-operation": "credit_agreement.advance",
      "x-hyperscale-operation-id": "credit_agreement_advance",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_advanced",
        "summary": "Receive credit_agreement.advanced events",
        "description": "Contract event payload projected from credit_agreement.advance. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.advanced",
        "x-hyperscale-operation": "credit_agreement.advance",
        "x-hyperscale-operation-id": "credit_agreement_advance",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.advanced"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.created": {
      "x-hyperscale-event-type": "credit_agreement.created",
      "x-hyperscale-operation": "credit_agreement.create",
      "x-hyperscale-operation-id": "credit_agreement_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_created",
        "summary": "Receive credit_agreement.created events",
        "description": "Contract event payload projected from credit_agreement.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.created",
        "x-hyperscale-operation": "credit_agreement.create",
        "x-hyperscale-operation-id": "credit_agreement_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.refinanced": {
      "x-hyperscale-event-type": "credit_agreement.refinanced",
      "x-hyperscale-operation": "credit_agreement.refinance",
      "x-hyperscale-operation-id": "credit_agreement_refinance",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_refinanced",
        "summary": "Receive credit_agreement.refinanced events",
        "description": "Contract event payload projected from credit_agreement.refinance. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.refinanced",
        "x-hyperscale-operation": "credit_agreement.refinance",
        "x-hyperscale-operation-id": "credit_agreement_refinance",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.refinanced"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.rescheduled": {
      "x-hyperscale-event-type": "credit_agreement.rescheduled",
      "x-hyperscale-operation": "credit_agreement.reschedule",
      "x-hyperscale-operation-id": "credit_agreement_reschedule",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_rescheduled",
        "summary": "Receive credit_agreement.rescheduled events",
        "description": "Contract event payload projected from credit_agreement.reschedule. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.rescheduled",
        "x-hyperscale-operation": "credit_agreement.reschedule",
        "x-hyperscale-operation-id": "credit_agreement_reschedule",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.rescheduled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.settled": {
      "x-hyperscale-event-type": "credit_agreement.settled",
      "x-hyperscale-operation": "credit_agreement.settle",
      "x-hyperscale-operation-id": "credit_agreement_settle",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_settled",
        "summary": "Receive credit_agreement.settled events",
        "description": "Contract event payload projected from credit_agreement.settle. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.settled",
        "x-hyperscale-operation": "credit_agreement.settle",
        "x-hyperscale-operation-id": "credit_agreement_settle",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.settled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.updated": {
      "x-hyperscale-event-type": "credit_agreement.updated",
      "x-hyperscale-operation": "credit_agreement.update",
      "x-hyperscale-operation-id": "credit_agreement_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_updated",
        "summary": "Receive credit_agreement.updated events",
        "description": "Contract event payload projected from credit_agreement.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.updated",
        "x-hyperscale-operation": "credit_agreement.update",
        "x-hyperscale-operation-id": "credit_agreement_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "credit_agreement.written_off": {
      "x-hyperscale-event-type": "credit_agreement.written_off",
      "x-hyperscale-operation": "credit_agreement.write_off",
      "x-hyperscale-operation-id": "credit_agreement_write_off",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_credit_agreement_written_off",
        "summary": "Receive credit_agreement.written_off events",
        "description": "Contract event payload projected from credit_agreement.write_off. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "credit_agreement.written_off",
        "x-hyperscale-operation": "credit_agreement.write_off",
        "x-hyperscale-operation-id": "credit_agreement_write_off",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "credit_agreement.written_off"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "customer.created": {
      "x-hyperscale-event-type": "customer.created",
      "x-hyperscale-operation": "customer.create",
      "x-hyperscale-operation-id": "customer_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_customer_created",
        "summary": "Receive customer.created events",
        "description": "Contract event payload projected from customer.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "customer.created",
        "x-hyperscale-operation": "customer.create",
        "x-hyperscale-operation-id": "customer_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "customer.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "customer.session.revoked": {
      "x-hyperscale-event-type": "customer.session.revoked",
      "x-hyperscale-operation": "customer.session.revoke",
      "x-hyperscale-operation-id": "customer_session_revoke",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_customer_session_revoked",
        "summary": "Receive customer.session.revoked events",
        "description": "Contract event payload projected from customer.session.revoke. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "customer.session.revoked",
        "x-hyperscale-operation": "customer.session.revoke",
        "x-hyperscale-operation-id": "customer_session_revoke",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "customer.session.revoked"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "customer.signed_up": {
      "x-hyperscale-event-type": "customer.signed_up",
      "x-hyperscale-operation": "customer.signup",
      "x-hyperscale-operation-id": "customer_signup",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_customer_signed_up",
        "summary": "Receive customer.signed_up events",
        "description": "Contract event payload projected from customer.signup. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "customer.signed_up",
        "x-hyperscale-operation": "customer.signup",
        "x-hyperscale-operation-id": "customer_signup",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "customer.signed_up"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "customer_access.closed": {
      "x-hyperscale-event-type": "customer_access.closed",
      "x-hyperscale-operation": "customer_access.close",
      "x-hyperscale-operation-id": "customer_access_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_customer_access_closed",
        "summary": "Receive customer_access.closed events",
        "description": "Contract event payload projected from customer_access.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "customer_access.closed",
        "x-hyperscale-operation": "customer_access.close",
        "x-hyperscale-operation-id": "customer_access_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "customer_access.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "customer_access.reactivated": {
      "x-hyperscale-event-type": "customer_access.reactivated",
      "x-hyperscale-operation": "customer_access.reactivate",
      "x-hyperscale-operation-id": "customer_access_reactivate",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_customer_access_reactivated",
        "summary": "Receive customer_access.reactivated events",
        "description": "Contract event payload projected from customer_access.reactivate. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "customer_access.reactivated",
        "x-hyperscale-operation": "customer_access.reactivate",
        "x-hyperscale-operation-id": "customer_access_reactivate",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "customer_access.reactivated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "customer_access.suspended": {
      "x-hyperscale-event-type": "customer_access.suspended",
      "x-hyperscale-operation": "customer_access.suspend",
      "x-hyperscale-operation-id": "customer_access_suspend",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_customer_access_suspended",
        "summary": "Receive customer_access.suspended events",
        "description": "Contract event payload projected from customer_access.suspend. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "customer_access.suspended",
        "x-hyperscale-operation": "customer_access.suspend",
        "x-hyperscale-operation-id": "customer_access_suspend",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "customer_access.suspended"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.canceled": {
      "x-hyperscale-event-type": "escrow_order.canceled",
      "x-hyperscale-operation": "escrow_order.cancel",
      "x-hyperscale-operation-id": "escrow_order_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_canceled",
        "summary": "Receive escrow_order.canceled events",
        "description": "Contract event payload projected from escrow_order.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.canceled",
        "x-hyperscale-operation": "escrow_order.cancel",
        "x-hyperscale-operation-id": "escrow_order_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.created": {
      "x-hyperscale-event-type": "escrow_order.created",
      "x-hyperscale-operation": "escrow_order.create",
      "x-hyperscale-operation-id": "escrow_order_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_created",
        "summary": "Receive escrow_order.created events",
        "description": "Contract event payload projected from escrow_order.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.created",
        "x-hyperscale-operation": "escrow_order.create",
        "x-hyperscale-operation-id": "escrow_order_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.disputed": {
      "x-hyperscale-event-type": "escrow_order.disputed",
      "x-hyperscale-operation": "escrow_order.dispute",
      "x-hyperscale-operation-id": "escrow_order_dispute",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_disputed",
        "summary": "Receive escrow_order.disputed events",
        "description": "Contract event payload projected from escrow_order.dispute. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.disputed",
        "x-hyperscale-operation": "escrow_order.dispute",
        "x-hyperscale-operation-id": "escrow_order_dispute",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.disputed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.funded": {
      "x-hyperscale-event-type": "escrow_order.funded",
      "x-hyperscale-operation": "escrow_order.fund",
      "x-hyperscale-operation-id": "escrow_order_fund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_funded",
        "summary": "Receive escrow_order.funded events",
        "description": "Contract event payload projected from escrow_order.fund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.funded",
        "x-hyperscale-operation": "escrow_order.fund",
        "x-hyperscale-operation-id": "escrow_order_fund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.penalty_collected": {
      "x-hyperscale-event-type": "escrow_order.penalty_collected",
      "x-hyperscale-operation": "escrow_order.collect_penalty",
      "x-hyperscale-operation-id": "escrow_order_collect_penalty",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_penalty_collected",
        "summary": "Receive escrow_order.penalty_collected events",
        "description": "Contract event payload projected from escrow_order.collect_penalty. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.penalty_collected",
        "x-hyperscale-operation": "escrow_order.collect_penalty",
        "x-hyperscale-operation-id": "escrow_order_collect_penalty",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.penalty_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.quoted": {
      "x-hyperscale-event-type": "escrow_order.quoted",
      "x-hyperscale-operation": "escrow_order.quote",
      "x-hyperscale-operation-id": "escrow_order_quote",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_quoted",
        "summary": "Receive escrow_order.quoted events",
        "description": "Contract event payload projected from escrow_order.quote. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.quoted",
        "x-hyperscale-operation": "escrow_order.quote",
        "x-hyperscale-operation-id": "escrow_order_quote",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.quoted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.refunded": {
      "x-hyperscale-event-type": "escrow_order.refunded",
      "x-hyperscale-operation": "escrow_order.refund",
      "x-hyperscale-operation-id": "escrow_order_refund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_refunded",
        "summary": "Receive escrow_order.refunded events",
        "description": "Contract event payload projected from escrow_order.refund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.refunded",
        "x-hyperscale-operation": "escrow_order.refund",
        "x-hyperscale-operation-id": "escrow_order_refund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.released": {
      "x-hyperscale-event-type": "escrow_order.released",
      "x-hyperscale-operation": "escrow_order.release",
      "x-hyperscale-operation-id": "escrow_order_release",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_released",
        "summary": "Receive escrow_order.released events",
        "description": "Contract event payload projected from escrow_order.release. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.released",
        "x-hyperscale-operation": "escrow_order.release",
        "x-hyperscale-operation-id": "escrow_order_release",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.resumed": {
      "x-hyperscale-event-type": "escrow_order.resumed",
      "x-hyperscale-operation": "escrow_order.resume",
      "x-hyperscale-operation-id": "escrow_order_resume",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_resumed",
        "summary": "Receive escrow_order.resumed events",
        "description": "Contract event payload projected from escrow_order.resume. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.resumed",
        "x-hyperscale-operation": "escrow_order.resume",
        "x-hyperscale-operation-id": "escrow_order_resume",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.resumed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "escrow_order.updated": {
      "x-hyperscale-event-type": "escrow_order.updated",
      "x-hyperscale-operation": "escrow_order.update",
      "x-hyperscale-operation-id": "escrow_order_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_escrow_order_updated",
        "summary": "Receive escrow_order.updated events",
        "description": "Contract event payload projected from escrow_order.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "escrow_order.updated",
        "x-hyperscale-operation": "escrow_order.update",
        "x-hyperscale-operation-id": "escrow_order_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "escrow_order.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "expected_payment.canceled": {
      "x-hyperscale-event-type": "expected_payment.canceled",
      "x-hyperscale-operation": "expected_payment.cancel",
      "x-hyperscale-operation-id": "expected_payment_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_expected_payment_canceled",
        "summary": "Receive expected_payment.canceled events",
        "description": "Contract event payload projected from expected_payment.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "expected_payment.canceled",
        "x-hyperscale-operation": "expected_payment.cancel",
        "x-hyperscale-operation-id": "expected_payment_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "expected_payment.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "expected_payment.created": {
      "x-hyperscale-event-type": "expected_payment.created",
      "x-hyperscale-operation": "expected_payment.create",
      "x-hyperscale-operation-id": "expected_payment_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_expected_payment_created",
        "summary": "Receive expected_payment.created events",
        "description": "Contract event payload projected from expected_payment.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "expected_payment.created",
        "x-hyperscale-operation": "expected_payment.create",
        "x-hyperscale-operation-id": "expected_payment_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "expected_payment.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "exposure_arrangement.approved": {
      "x-hyperscale-event-type": "exposure_arrangement.approved",
      "x-hyperscale-operation": "exposure_arrangement.approve",
      "x-hyperscale-operation-id": "exposure_arrangement_approve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_exposure_arrangement_approved",
        "summary": "Receive exposure_arrangement.approved events",
        "description": "Contract event payload projected from exposure_arrangement.approve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "exposure_arrangement.approved",
        "x-hyperscale-operation": "exposure_arrangement.approve",
        "x-hyperscale-operation-id": "exposure_arrangement_approve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "exposure_arrangement.approved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "exposure_arrangement.closed": {
      "x-hyperscale-event-type": "exposure_arrangement.closed",
      "x-hyperscale-operation": "exposure_arrangement.close",
      "x-hyperscale-operation-id": "exposure_arrangement_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_exposure_arrangement_closed",
        "summary": "Receive exposure_arrangement.closed events",
        "description": "Contract event payload projected from exposure_arrangement.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "exposure_arrangement.closed",
        "x-hyperscale-operation": "exposure_arrangement.close",
        "x-hyperscale-operation-id": "exposure_arrangement_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "exposure_arrangement.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "exposure_arrangement.rejected": {
      "x-hyperscale-event-type": "exposure_arrangement.rejected",
      "x-hyperscale-operation": "exposure_arrangement.reject",
      "x-hyperscale-operation-id": "exposure_arrangement_reject",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_exposure_arrangement_rejected",
        "summary": "Receive exposure_arrangement.rejected events",
        "description": "Contract event payload projected from exposure_arrangement.reject. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "exposure_arrangement.rejected",
        "x-hyperscale-operation": "exposure_arrangement.reject",
        "x-hyperscale-operation-id": "exposure_arrangement_reject",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "exposure_arrangement.rejected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "exposure_arrangement.updated": {
      "x-hyperscale-event-type": "exposure_arrangement.updated",
      "x-hyperscale-operation": "exposure_arrangement.update",
      "x-hyperscale-operation-id": "exposure_arrangement_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_exposure_arrangement_updated",
        "summary": "Receive exposure_arrangement.updated events",
        "description": "Contract event payload projected from exposure_arrangement.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "exposure_arrangement.updated",
        "x-hyperscale-operation": "exposure_arrangement.update",
        "x-hyperscale-operation-id": "exposure_arrangement_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "exposure_arrangement.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "financial_address.disabled": {
      "x-hyperscale-event-type": "financial_address.disabled",
      "x-hyperscale-operation": "financial_address.disable",
      "x-hyperscale-operation-id": "financial_address_disable",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_financial_address_disabled",
        "summary": "Receive financial_address.disabled events",
        "description": "Contract event payload projected from financial_address.disable. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "financial_address.disabled",
        "x-hyperscale-operation": "financial_address.disable",
        "x-hyperscale-operation-id": "financial_address_disable",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "financial_address.disabled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "financial_address.requested": {
      "x-hyperscale-event-type": "financial_address.requested",
      "x-hyperscale-operation": "financial_address.create",
      "x-hyperscale-operation-id": "financial_address_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_financial_address_requested",
        "summary": "Receive financial_address.requested events",
        "description": "Contract event payload projected from financial_address.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "financial_address.requested",
        "x-hyperscale-operation": "financial_address.create",
        "x-hyperscale-operation-id": "financial_address_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "financial_address.requested"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.amendment_collected": {
      "x-hyperscale-event-type": "flight_booking.amendment_collected",
      "x-hyperscale-operation": "flight_booking.amend_collect",
      "x-hyperscale-operation-id": "flight_booking_amend_collect",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_amendment_collected",
        "summary": "Receive flight_booking.amendment_collected events",
        "description": "Contract event payload projected from flight_booking.amend_collect. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.amendment_collected",
        "x-hyperscale-operation": "flight_booking.amend_collect",
        "x-hyperscale-operation-id": "flight_booking_amend_collect",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.amendment_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.amendment_fee_collected": {
      "x-hyperscale-event-type": "flight_booking.amendment_fee_collected",
      "x-hyperscale-operation": "flight_booking.amend_fee",
      "x-hyperscale-operation-id": "flight_booking_amend_fee",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_amendment_fee_collected",
        "summary": "Receive flight_booking.amendment_fee_collected events",
        "description": "Contract event payload projected from flight_booking.amend_fee. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.amendment_fee_collected",
        "x-hyperscale-operation": "flight_booking.amend_fee",
        "x-hyperscale-operation-id": "flight_booking_amend_fee",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.amendment_fee_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.amendment_refunded": {
      "x-hyperscale-event-type": "flight_booking.amendment_refunded",
      "x-hyperscale-operation": "flight_booking.amend_refund",
      "x-hyperscale-operation-id": "flight_booking_amend_refund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_amendment_refunded",
        "summary": "Receive flight_booking.amendment_refunded events",
        "description": "Contract event payload projected from flight_booking.amend_refund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.amendment_refunded",
        "x-hyperscale-operation": "flight_booking.amend_refund",
        "x-hyperscale-operation-id": "flight_booking_amend_refund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.amendment_refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.cancel_confirmed": {
      "x-hyperscale-event-type": "flight_booking.cancel_confirmed",
      "x-hyperscale-operation": "flight_booking.cancel_confirm",
      "x-hyperscale-operation-id": "flight_booking_cancel_confirm",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_cancel_confirmed",
        "summary": "Receive flight_booking.cancel_confirmed events",
        "description": "Contract event payload projected from flight_booking.cancel_confirm. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.cancel_confirmed",
        "x-hyperscale-operation": "flight_booking.cancel_confirm",
        "x-hyperscale-operation-id": "flight_booking_cancel_confirm",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.cancel_confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.cancel_quoted": {
      "x-hyperscale-event-type": "flight_booking.cancel_quoted",
      "x-hyperscale-operation": "flight_booking.cancel_quote",
      "x-hyperscale-operation-id": "flight_booking_cancel_quote",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_cancel_quoted",
        "summary": "Receive flight_booking.cancel_quoted events",
        "description": "Contract event payload projected from flight_booking.cancel_quote. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.cancel_quoted",
        "x-hyperscale-operation": "flight_booking.cancel_quote",
        "x-hyperscale-operation-id": "flight_booking_cancel_quote",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.cancel_quoted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.confirmed": {
      "x-hyperscale-event-type": "flight_booking.confirmed",
      "x-hyperscale-operation": "flight_booking.confirm",
      "x-hyperscale-operation-id": "flight_booking_confirm",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_confirmed",
        "summary": "Receive flight_booking.confirmed events",
        "description": "Contract event payload projected from flight_booking.confirm. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.confirmed",
        "x-hyperscale-operation": "flight_booking.confirm",
        "x-hyperscale-operation-id": "flight_booking_confirm",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.created": {
      "x-hyperscale-event-type": "flight_booking.created",
      "x-hyperscale-operation": "flight_booking.create",
      "x-hyperscale-operation-id": "flight_booking_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_created",
        "summary": "Receive flight_booking.created events",
        "description": "Contract event payload projected from flight_booking.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.created",
        "x-hyperscale-operation": "flight_booking.create",
        "x-hyperscale-operation-id": "flight_booking_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.penalty_collected": {
      "x-hyperscale-event-type": "flight_booking.penalty_collected",
      "x-hyperscale-operation": "flight_booking.collect_penalty",
      "x-hyperscale-operation-id": "flight_booking_collect_penalty",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_penalty_collected",
        "summary": "Receive flight_booking.penalty_collected events",
        "description": "Contract event payload projected from flight_booking.collect_penalty. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.penalty_collected",
        "x-hyperscale-operation": "flight_booking.collect_penalty",
        "x-hyperscale-operation-id": "flight_booking_collect_penalty",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.penalty_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.released": {
      "x-hyperscale-event-type": "flight_booking.released",
      "x-hyperscale-operation": "flight_booking.release",
      "x-hyperscale-operation-id": "flight_booking_release",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_released",
        "summary": "Receive flight_booking.released events",
        "description": "Contract event payload projected from flight_booking.release. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.released",
        "x-hyperscale-operation": "flight_booking.release",
        "x-hyperscale-operation-id": "flight_booking_release",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "flight_booking.updated": {
      "x-hyperscale-event-type": "flight_booking.updated",
      "x-hyperscale-operation": "flight_booking.update",
      "x-hyperscale-operation-id": "flight_booking_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_flight_booking_updated",
        "summary": "Receive flight_booking.updated events",
        "description": "Contract event payload projected from flight_booking.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "flight_booking.updated",
        "x-hyperscale-operation": "flight_booking.update",
        "x-hyperscale-operation-id": "flight_booking_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "flight_booking.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "funding_commitment.created": {
      "x-hyperscale-event-type": "funding_commitment.created",
      "x-hyperscale-operation": "funding_commitment.create",
      "x-hyperscale-operation-id": "funding_commitment_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_funding_commitment_created",
        "summary": "Receive funding_commitment.created events",
        "description": "Contract event payload projected from funding_commitment.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "funding_commitment.created",
        "x-hyperscale-operation": "funding_commitment.create",
        "x-hyperscale-operation-id": "funding_commitment_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "funding_commitment.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "funding_round.closed": {
      "x-hyperscale-event-type": "funding_round.closed",
      "x-hyperscale-operation": "funding_round.close",
      "x-hyperscale-operation-id": "funding_round_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_funding_round_closed",
        "summary": "Receive funding_round.closed events",
        "description": "Contract event payload projected from funding_round.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "funding_round.closed",
        "x-hyperscale-operation": "funding_round.close",
        "x-hyperscale-operation-id": "funding_round_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "funding_round.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "funding_round.created": {
      "x-hyperscale-event-type": "funding_round.created",
      "x-hyperscale-operation": "funding_round.create",
      "x-hyperscale-operation-id": "funding_round_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_funding_round_created",
        "summary": "Receive funding_round.created events",
        "description": "Contract event payload projected from funding_round.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "funding_round.created",
        "x-hyperscale-operation": "funding_round.create",
        "x-hyperscale-operation-id": "funding_round_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "funding_round.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "held_settlement.abandoned": {
      "x-hyperscale-event-type": "held_settlement.abandoned",
      "x-hyperscale-operation": "held_settlement.abandon",
      "x-hyperscale-operation-id": "held_settlement_abandon",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_held_settlement_abandoned",
        "summary": "Receive held_settlement.abandoned events",
        "description": "Contract event payload projected from held_settlement.abandon. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "held_settlement.abandoned",
        "x-hyperscale-operation": "held_settlement.abandon",
        "x-hyperscale-operation-id": "held_settlement_abandon",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "held_settlement.abandoned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "held_settlement.cancelled": {
      "x-hyperscale-event-type": "held_settlement.cancelled",
      "x-hyperscale-operation": "held_settlement.cancel",
      "x-hyperscale-operation-id": "held_settlement_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_held_settlement_cancelled",
        "summary": "Receive held_settlement.cancelled events",
        "description": "Contract event payload projected from held_settlement.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "held_settlement.cancelled",
        "x-hyperscale-operation": "held_settlement.cancel",
        "x-hyperscale-operation-id": "held_settlement_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "held_settlement.cancelled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "held_settlement.created": {
      "x-hyperscale-event-type": "held_settlement.created",
      "x-hyperscale-operation": "held_settlement.create",
      "x-hyperscale-operation-id": "held_settlement_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_held_settlement_created",
        "summary": "Receive held_settlement.created events",
        "description": "Contract event payload projected from held_settlement.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "held_settlement.created",
        "x-hyperscale-operation": "held_settlement.create",
        "x-hyperscale-operation-id": "held_settlement_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "held_settlement.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "held_settlement.funded": {
      "x-hyperscale-event-type": "held_settlement.funded",
      "x-hyperscale-operation": "held_settlement.fund",
      "x-hyperscale-operation-id": "held_settlement_fund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_held_settlement_funded",
        "summary": "Receive held_settlement.funded events",
        "description": "Contract event payload projected from held_settlement.fund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "held_settlement.funded",
        "x-hyperscale-operation": "held_settlement.fund",
        "x-hyperscale-operation-id": "held_settlement_fund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "held_settlement.funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "held_settlement.released": {
      "x-hyperscale-event-type": "held_settlement.released",
      "x-hyperscale-operation": "held_settlement.release",
      "x-hyperscale-operation-id": "held_settlement_release",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_held_settlement_released",
        "summary": "Receive held_settlement.released events",
        "description": "Contract event payload projected from held_settlement.release. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "held_settlement.released",
        "x-hyperscale-operation": "held_settlement.release",
        "x-hyperscale-operation-id": "held_settlement_release",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "held_settlement.released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.amendment_collected": {
      "x-hyperscale-event-type": "hotel_stay.amendment_collected",
      "x-hyperscale-operation": "hotel_stay.amend_collect",
      "x-hyperscale-operation-id": "hotel_stay_amend_collect",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_amendment_collected",
        "summary": "Receive hotel_stay.amendment_collected events",
        "description": "Contract event payload projected from hotel_stay.amend_collect. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.amendment_collected",
        "x-hyperscale-operation": "hotel_stay.amend_collect",
        "x-hyperscale-operation-id": "hotel_stay_amend_collect",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.amendment_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.amendment_fee_collected": {
      "x-hyperscale-event-type": "hotel_stay.amendment_fee_collected",
      "x-hyperscale-operation": "hotel_stay.amend_fee",
      "x-hyperscale-operation-id": "hotel_stay_amend_fee",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_amendment_fee_collected",
        "summary": "Receive hotel_stay.amendment_fee_collected events",
        "description": "Contract event payload projected from hotel_stay.amend_fee. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.amendment_fee_collected",
        "x-hyperscale-operation": "hotel_stay.amend_fee",
        "x-hyperscale-operation-id": "hotel_stay_amend_fee",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.amendment_fee_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.amendment_refunded": {
      "x-hyperscale-event-type": "hotel_stay.amendment_refunded",
      "x-hyperscale-operation": "hotel_stay.amend_refund",
      "x-hyperscale-operation-id": "hotel_stay_amend_refund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_amendment_refunded",
        "summary": "Receive hotel_stay.amendment_refunded events",
        "description": "Contract event payload projected from hotel_stay.amend_refund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.amendment_refunded",
        "x-hyperscale-operation": "hotel_stay.amend_refund",
        "x-hyperscale-operation-id": "hotel_stay_amend_refund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.amendment_refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.cancel_confirmed": {
      "x-hyperscale-event-type": "hotel_stay.cancel_confirmed",
      "x-hyperscale-operation": "hotel_stay.cancel_confirm",
      "x-hyperscale-operation-id": "hotel_stay_cancel_confirm",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_cancel_confirmed",
        "summary": "Receive hotel_stay.cancel_confirmed events",
        "description": "Contract event payload projected from hotel_stay.cancel_confirm. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.cancel_confirmed",
        "x-hyperscale-operation": "hotel_stay.cancel_confirm",
        "x-hyperscale-operation-id": "hotel_stay_cancel_confirm",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.cancel_confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.cancel_quoted": {
      "x-hyperscale-event-type": "hotel_stay.cancel_quoted",
      "x-hyperscale-operation": "hotel_stay.cancel_quote",
      "x-hyperscale-operation-id": "hotel_stay_cancel_quote",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_cancel_quoted",
        "summary": "Receive hotel_stay.cancel_quoted events",
        "description": "Contract event payload projected from hotel_stay.cancel_quote. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.cancel_quoted",
        "x-hyperscale-operation": "hotel_stay.cancel_quote",
        "x-hyperscale-operation-id": "hotel_stay_cancel_quote",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.cancel_quoted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.confirmed": {
      "x-hyperscale-event-type": "hotel_stay.confirmed",
      "x-hyperscale-operation": "hotel_stay.confirm",
      "x-hyperscale-operation-id": "hotel_stay_confirm",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_confirmed",
        "summary": "Receive hotel_stay.confirmed events",
        "description": "Contract event payload projected from hotel_stay.confirm. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.confirmed",
        "x-hyperscale-operation": "hotel_stay.confirm",
        "x-hyperscale-operation-id": "hotel_stay_confirm",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.created": {
      "x-hyperscale-event-type": "hotel_stay.created",
      "x-hyperscale-operation": "hotel_stay.create",
      "x-hyperscale-operation-id": "hotel_stay_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_created",
        "summary": "Receive hotel_stay.created events",
        "description": "Contract event payload projected from hotel_stay.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.created",
        "x-hyperscale-operation": "hotel_stay.create",
        "x-hyperscale-operation-id": "hotel_stay_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.penalty_collected": {
      "x-hyperscale-event-type": "hotel_stay.penalty_collected",
      "x-hyperscale-operation": "hotel_stay.collect_penalty",
      "x-hyperscale-operation-id": "hotel_stay_collect_penalty",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_penalty_collected",
        "summary": "Receive hotel_stay.penalty_collected events",
        "description": "Contract event payload projected from hotel_stay.collect_penalty. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.penalty_collected",
        "x-hyperscale-operation": "hotel_stay.collect_penalty",
        "x-hyperscale-operation-id": "hotel_stay_collect_penalty",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.penalty_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.released": {
      "x-hyperscale-event-type": "hotel_stay.released",
      "x-hyperscale-operation": "hotel_stay.release",
      "x-hyperscale-operation-id": "hotel_stay_release",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_released",
        "summary": "Receive hotel_stay.released events",
        "description": "Contract event payload projected from hotel_stay.release. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.released",
        "x-hyperscale-operation": "hotel_stay.release",
        "x-hyperscale-operation-id": "hotel_stay_release",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "hotel_stay.updated": {
      "x-hyperscale-event-type": "hotel_stay.updated",
      "x-hyperscale-operation": "hotel_stay.update",
      "x-hyperscale-operation-id": "hotel_stay_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_hotel_stay_updated",
        "summary": "Receive hotel_stay.updated events",
        "description": "Contract event payload projected from hotel_stay.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "hotel_stay.updated",
        "x-hyperscale-operation": "hotel_stay.update",
        "x-hyperscale-operation-id": "hotel_stay_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "hotel_stay.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "installment.created": {
      "x-hyperscale-event-type": "installment.created",
      "x-hyperscale-operation": "installment.create",
      "x-hyperscale-operation-id": "installment_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_installment_created",
        "summary": "Receive installment.created events",
        "description": "Contract event payload projected from installment.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "installment.created",
        "x-hyperscale-operation": "installment.create",
        "x-hyperscale-operation-id": "installment_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "installment.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "installment.updated": {
      "x-hyperscale-event-type": "installment.updated",
      "x-hyperscale-operation": "installment.update",
      "x-hyperscale-operation-id": "installment_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_installment_updated",
        "summary": "Receive installment.updated events",
        "description": "Contract event payload projected from installment.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "installment.updated",
        "x-hyperscale-operation": "installment.update",
        "x-hyperscale-operation-id": "installment_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "installment.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "installment.written_off": {
      "x-hyperscale-event-type": "installment.written_off",
      "x-hyperscale-operation": "installment.write_off",
      "x-hyperscale-operation-id": "installment_write_off",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_installment_written_off",
        "summary": "Receive installment.written_off events",
        "description": "Contract event payload projected from installment.write_off. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "installment.written_off",
        "x-hyperscale-operation": "installment.write_off",
        "x-hyperscale-operation-id": "installment_write_off",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "installment.written_off"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.adjusted": {
      "x-hyperscale-event-type": "internal_transfer.adjusted",
      "x-hyperscale-operation": "internal_transfer.adjust",
      "x-hyperscale-operation-id": "internal_transfer_adjust",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_internal_transfer_adjusted",
        "summary": "Receive internal_transfer.adjusted events",
        "description": "Contract event payload projected from internal_transfer.adjust. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.adjusted",
        "x-hyperscale-operation": "internal_transfer.adjust",
        "x-hyperscale-operation-id": "internal_transfer_adjust",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.adjusted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.created": {
      "x-hyperscale-event-type": "internal_transfer.created",
      "x-hyperscale-operation": "internal_transfer.create",
      "x-hyperscale-operation-id": "internal_transfer_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_internal_transfer_created",
        "summary": "Receive internal_transfer.created events",
        "description": "Contract event payload projected from internal_transfer.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.created",
        "x-hyperscale-operation": "internal_transfer.create",
        "x-hyperscale-operation-id": "internal_transfer_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.partially_posted": {
      "x-hyperscale-event-type": "internal_transfer.partially_posted",
      "x-hyperscale-operation": "internal_transfer.post",
      "x-hyperscale-operation-id": "internal_transfer_post",
      "x-hyperscale-status": "succeeded",
      "x-hyperscale-outcome": "reserved",
      "post": {
        "operationId": "webhook_internal_transfer_partially_posted",
        "summary": "Receive internal_transfer.partially_posted events",
        "description": "Contract event payload projected from internal_transfer.post. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.partially_posted",
        "x-hyperscale-operation": "internal_transfer.post",
        "x-hyperscale-operation-id": "internal_transfer_post",
        "x-hyperscale-status": "succeeded",
        "x-hyperscale-outcome": "reserved",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.partially_posted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.posted": {
      "x-hyperscale-event-type": "internal_transfer.posted",
      "x-hyperscale-operation": "internal_transfer.post",
      "x-hyperscale-operation-id": "internal_transfer_post",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_internal_transfer_posted",
        "summary": "Receive internal_transfer.posted events",
        "description": "Contract event payload projected from internal_transfer.post. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.posted",
        "x-hyperscale-operation": "internal_transfer.post",
        "x-hyperscale-operation-id": "internal_transfer_post",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.posted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.reserved": {
      "x-hyperscale-event-type": "internal_transfer.reserved",
      "x-hyperscale-operation": "internal_transfer.reserve",
      "x-hyperscale-operation-id": "internal_transfer_reserve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_internal_transfer_reserved",
        "summary": "Receive internal_transfer.reserved events",
        "description": "Contract event payload projected from internal_transfer.reserve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.reserved",
        "x-hyperscale-operation": "internal_transfer.reserve",
        "x-hyperscale-operation-id": "internal_transfer_reserve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.reserved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.reversed": {
      "x-hyperscale-event-type": "internal_transfer.reversed",
      "x-hyperscale-operation": "internal_transfer.reverse",
      "x-hyperscale-operation-id": "internal_transfer_reverse",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_internal_transfer_reversed",
        "summary": "Receive internal_transfer.reversed events",
        "description": "Contract event payload projected from internal_transfer.reverse. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.reversed",
        "x-hyperscale-operation": "internal_transfer.reverse",
        "x-hyperscale-operation-id": "internal_transfer_reverse",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.reversed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "internal_transfer.voided": {
      "x-hyperscale-event-type": "internal_transfer.voided",
      "x-hyperscale-operation": "internal_transfer.void",
      "x-hyperscale-operation-id": "internal_transfer_void",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_internal_transfer_voided",
        "summary": "Receive internal_transfer.voided events",
        "description": "Contract event payload projected from internal_transfer.void. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "internal_transfer.voided",
        "x-hyperscale-operation": "internal_transfer.void",
        "x-hyperscale-operation-id": "internal_transfer_void",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "internal_transfer.voided"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "lender_distribution.created": {
      "x-hyperscale-event-type": "lender_distribution.created",
      "x-hyperscale-operation": "lender_distribution.create",
      "x-hyperscale-operation-id": "lender_distribution_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_lender_distribution_created",
        "summary": "Receive lender_distribution.created events",
        "description": "Contract event payload projected from lender_distribution.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "lender_distribution.created",
        "x-hyperscale-operation": "lender_distribution.create",
        "x-hyperscale-operation-id": "lender_distribution_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "lender_distribution.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.created": {
      "x-hyperscale-event-type": "listing.created",
      "x-hyperscale-operation": "listing.create",
      "x-hyperscale-operation-id": "listing_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_created",
        "summary": "Receive listing.created events",
        "description": "Contract event payload projected from listing.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.created",
        "x-hyperscale-operation": "listing.create",
        "x-hyperscale-operation-id": "listing_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.published": {
      "x-hyperscale-event-type": "listing.published",
      "x-hyperscale-operation": "listing.publish",
      "x-hyperscale-operation-id": "listing_publish",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_published",
        "summary": "Receive listing.published events",
        "description": "Contract event payload projected from listing.publish. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.published",
        "x-hyperscale-operation": "listing.publish",
        "x-hyperscale-operation-id": "listing_publish",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.published"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.reopened": {
      "x-hyperscale-event-type": "listing.reopened",
      "x-hyperscale-operation": "listing.reopen",
      "x-hyperscale-operation-id": "listing_reopen",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_reopened",
        "summary": "Receive listing.reopened events",
        "description": "Contract event payload projected from listing.reopen. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.reopened",
        "x-hyperscale-operation": "listing.reopen",
        "x-hyperscale-operation-id": "listing_reopen",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.reopened"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.reserved": {
      "x-hyperscale-event-type": "listing.reserved",
      "x-hyperscale-operation": "listing.reserve",
      "x-hyperscale-operation-id": "listing_reserve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_reserved",
        "summary": "Receive listing.reserved events",
        "description": "Contract event payload projected from listing.reserve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.reserved",
        "x-hyperscale-operation": "listing.reserve",
        "x-hyperscale-operation-id": "listing_reserve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.reserved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.sold": {
      "x-hyperscale-event-type": "listing.sold",
      "x-hyperscale-operation": "listing.sell",
      "x-hyperscale-operation-id": "listing_sell",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_sold",
        "summary": "Receive listing.sold events",
        "description": "Contract event payload projected from listing.sell. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.sold",
        "x-hyperscale-operation": "listing.sell",
        "x-hyperscale-operation-id": "listing_sell",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.sold"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.updated": {
      "x-hyperscale-event-type": "listing.updated",
      "x-hyperscale-operation": "listing.update",
      "x-hyperscale-operation-id": "listing_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_updated",
        "summary": "Receive listing.updated events",
        "description": "Contract event payload projected from listing.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.updated",
        "x-hyperscale-operation": "listing.update",
        "x-hyperscale-operation-id": "listing_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "listing.withdrawn": {
      "x-hyperscale-event-type": "listing.withdrawn",
      "x-hyperscale-operation": "listing.withdraw",
      "x-hyperscale-operation-id": "listing_withdraw",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_listing_withdrawn",
        "summary": "Receive listing.withdrawn events",
        "description": "Contract event payload projected from listing.withdraw. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "listing.withdrawn",
        "x-hyperscale-operation": "listing.withdraw",
        "x-hyperscale-operation-id": "listing_withdraw",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "listing.withdrawn"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.bound": {
      "x-hyperscale-event-type": "motor_policy.bound",
      "x-hyperscale-operation": "motor_policy.bind",
      "x-hyperscale-operation-id": "motor_policy_bind",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_bound",
        "summary": "Receive motor_policy.bound events",
        "description": "Contract event payload projected from motor_policy.bind. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.bound",
        "x-hyperscale-operation": "motor_policy.bind",
        "x-hyperscale-operation-id": "motor_policy_bind",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.bound"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.canceled": {
      "x-hyperscale-event-type": "motor_policy.canceled",
      "x-hyperscale-operation": "motor_policy.cancel",
      "x-hyperscale-operation-id": "motor_policy_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_canceled",
        "summary": "Receive motor_policy.canceled events",
        "description": "Contract event payload projected from motor_policy.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.canceled",
        "x-hyperscale-operation": "motor_policy.cancel",
        "x-hyperscale-operation-id": "motor_policy_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.claim_settled": {
      "x-hyperscale-event-type": "motor_policy.claim_settled",
      "x-hyperscale-operation": "motor_policy.settle_claim",
      "x-hyperscale-operation-id": "motor_policy_settle_claim",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_claim_settled",
        "summary": "Receive motor_policy.claim_settled events",
        "description": "Contract event payload projected from motor_policy.settle_claim. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.claim_settled",
        "x-hyperscale-operation": "motor_policy.settle_claim",
        "x-hyperscale-operation-id": "motor_policy_settle_claim",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.claim_settled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.created": {
      "x-hyperscale-event-type": "motor_policy.created",
      "x-hyperscale-operation": "motor_policy.create",
      "x-hyperscale-operation-id": "motor_policy_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_created",
        "summary": "Receive motor_policy.created events",
        "description": "Contract event payload projected from motor_policy.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.created",
        "x-hyperscale-operation": "motor_policy.create",
        "x-hyperscale-operation-id": "motor_policy_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.deny_claimed": {
      "x-hyperscale-event-type": "motor_policy.deny_claimed",
      "x-hyperscale-operation": "motor_policy.deny_claim",
      "x-hyperscale-operation-id": "motor_policy_deny_claim",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_deny_claimed",
        "summary": "Receive motor_policy.deny_claimed events",
        "description": "Contract event payload projected from motor_policy.deny_claim. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.deny_claimed",
        "x-hyperscale-operation": "motor_policy.deny_claim",
        "x-hyperscale-operation-id": "motor_policy_deny_claim",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.deny_claimed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.open_claimed": {
      "x-hyperscale-event-type": "motor_policy.open_claimed",
      "x-hyperscale-operation": "motor_policy.open_claim",
      "x-hyperscale-operation-id": "motor_policy_open_claim",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_open_claimed",
        "summary": "Receive motor_policy.open_claimed events",
        "description": "Contract event payload projected from motor_policy.open_claim. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.open_claimed",
        "x-hyperscale-operation": "motor_policy.open_claim",
        "x-hyperscale-operation-id": "motor_policy_open_claim",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.open_claimed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "motor_policy.updated": {
      "x-hyperscale-event-type": "motor_policy.updated",
      "x-hyperscale-operation": "motor_policy.update",
      "x-hyperscale-operation-id": "motor_policy_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_motor_policy_updated",
        "summary": "Receive motor_policy.updated events",
        "description": "Contract event payload projected from motor_policy.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "motor_policy.updated",
        "x-hyperscale-operation": "motor_policy.update",
        "x-hyperscale-operation-id": "motor_policy_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "motor_policy.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "order.canceled": {
      "x-hyperscale-event-type": "order.canceled",
      "x-hyperscale-operation": "order.cancel",
      "x-hyperscale-operation-id": "order_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_order_canceled",
        "summary": "Receive order.canceled events",
        "description": "Contract event payload projected from order.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "order.canceled",
        "x-hyperscale-operation": "order.cancel",
        "x-hyperscale-operation-id": "order_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "order.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "order.confirmed": {
      "x-hyperscale-event-type": "order.confirmed",
      "x-hyperscale-operation": "order.confirm",
      "x-hyperscale-operation-id": "order_confirm",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_order_confirmed",
        "summary": "Receive order.confirmed events",
        "description": "Contract event payload projected from order.confirm. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "order.confirmed",
        "x-hyperscale-operation": "order.confirm",
        "x-hyperscale-operation-id": "order_confirm",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "order.confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "order.created": {
      "x-hyperscale-event-type": "order.created",
      "x-hyperscale-operation": "order.create",
      "x-hyperscale-operation-id": "order_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_order_created",
        "summary": "Receive order.created events",
        "description": "Contract event payload projected from order.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "order.created",
        "x-hyperscale-operation": "order.create",
        "x-hyperscale-operation-id": "order_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "order.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "order.fulfilled": {
      "x-hyperscale-event-type": "order.fulfilled",
      "x-hyperscale-operation": "order.fulfill",
      "x-hyperscale-operation-id": "order_fulfill",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_order_fulfilled",
        "summary": "Receive order.fulfilled events",
        "description": "Contract event payload projected from order.fulfill. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "order.fulfilled",
        "x-hyperscale-operation": "order.fulfill",
        "x-hyperscale-operation-id": "order_fulfill",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "order.fulfilled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "order.updated": {
      "x-hyperscale-event-type": "order.updated",
      "x-hyperscale-operation": "order.update",
      "x-hyperscale-operation-id": "order_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_order_updated",
        "summary": "Receive order.updated events",
        "description": "Contract event payload projected from order.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "order.updated",
        "x-hyperscale-operation": "order.update",
        "x-hyperscale-operation-id": "order_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "order.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "payout.created": {
      "x-hyperscale-event-type": "payout.created",
      "x-hyperscale-operation": "payout.create",
      "x-hyperscale-operation-id": "payout_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_payout_created",
        "summary": "Receive payout.created events",
        "description": "Contract event payload projected from payout.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "payout.created",
        "x-hyperscale-operation": "payout.create",
        "x-hyperscale-operation-id": "payout_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "payout.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "payout_run.canceled": {
      "x-hyperscale-event-type": "payout_run.canceled",
      "x-hyperscale-operation": "payout_run.cancel",
      "x-hyperscale-operation-id": "payout_run_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_payout_run_canceled",
        "summary": "Receive payout_run.canceled events",
        "description": "Contract event payload projected from payout_run.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "payout_run.canceled",
        "x-hyperscale-operation": "payout_run.cancel",
        "x-hyperscale-operation-id": "payout_run_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "payout_run.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "payout_run.created": {
      "x-hyperscale-event-type": "payout_run.created",
      "x-hyperscale-operation": "payout_run.create",
      "x-hyperscale-operation-id": "payout_run_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_payout_run_created",
        "summary": "Receive payout_run.created events",
        "description": "Contract event payload projected from payout_run.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "payout_run.created",
        "x-hyperscale-operation": "payout_run.create",
        "x-hyperscale-operation-id": "payout_run_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "payout_run.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "payout_run.updated": {
      "x-hyperscale-event-type": "payout_run.updated",
      "x-hyperscale-operation": "payout_run.update",
      "x-hyperscale-operation-id": "payout_run_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_payout_run_updated",
        "summary": "Receive payout_run.updated events",
        "description": "Contract event payload projected from payout_run.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "payout_run.updated",
        "x-hyperscale-operation": "payout_run.update",
        "x-hyperscale-operation-id": "payout_run_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "payout_run.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "payout_run.withheld": {
      "x-hyperscale-event-type": "payout_run.withheld",
      "x-hyperscale-operation": "payout_run.withhold",
      "x-hyperscale-operation-id": "payout_run_withhold",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_payout_run_withheld",
        "summary": "Receive payout_run.withheld events",
        "description": "Contract event payload projected from payout_run.withhold. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "payout_run.withheld",
        "x-hyperscale-operation": "payout_run.withhold",
        "x-hyperscale-operation-id": "payout_run_withhold",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "payout_run.withheld"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.bound": {
      "x-hyperscale-event-type": "policy.bound",
      "x-hyperscale-operation": "policy.bind",
      "x-hyperscale-operation-id": "policy_bind",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_bound",
        "summary": "Receive policy.bound events",
        "description": "Contract event payload projected from policy.bind. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.bound",
        "x-hyperscale-operation": "policy.bind",
        "x-hyperscale-operation-id": "policy_bind",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.bound"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.canceled": {
      "x-hyperscale-event-type": "policy.canceled",
      "x-hyperscale-operation": "policy.cancel",
      "x-hyperscale-operation-id": "policy_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_canceled",
        "summary": "Receive policy.canceled events",
        "description": "Contract event payload projected from policy.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.canceled",
        "x-hyperscale-operation": "policy.cancel",
        "x-hyperscale-operation-id": "policy_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.endorsed": {
      "x-hyperscale-event-type": "policy.endorsed",
      "x-hyperscale-operation": "policy.endorse",
      "x-hyperscale-operation-id": "policy_endorse",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_endorsed",
        "summary": "Receive policy.endorsed events",
        "description": "Contract event payload projected from policy.endorse. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.endorsed",
        "x-hyperscale-operation": "policy.endorse",
        "x-hyperscale-operation-id": "policy_endorse",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.endorsed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.previewed": {
      "x-hyperscale-event-type": "policy.previewed",
      "x-hyperscale-operation": "policy.preview",
      "x-hyperscale-operation-id": "policy_preview",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_previewed",
        "summary": "Receive policy.previewed events",
        "description": "Contract event payload projected from policy.preview. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.previewed",
        "x-hyperscale-operation": "policy.preview",
        "x-hyperscale-operation-id": "policy_preview",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.previewed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.quoted": {
      "x-hyperscale-event-type": "policy.quoted",
      "x-hyperscale-operation": "policy.create",
      "x-hyperscale-operation-id": "policy_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_quoted",
        "summary": "Receive policy.quoted events",
        "description": "Contract event payload projected from policy.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.quoted",
        "x-hyperscale-operation": "policy.create",
        "x-hyperscale-operation-id": "policy_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.quoted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.updated": {
      "x-hyperscale-event-type": "policy.updated",
      "x-hyperscale-operation": "policy.update",
      "x-hyperscale-operation-id": "policy_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_updated",
        "summary": "Receive policy.updated events",
        "description": "Contract event payload projected from policy.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.updated",
        "x-hyperscale-operation": "policy.update",
        "x-hyperscale-operation-id": "policy_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "policy.withdrawn": {
      "x-hyperscale-event-type": "policy.withdrawn",
      "x-hyperscale-operation": "policy.withdraw",
      "x-hyperscale-operation-id": "policy_withdraw",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_policy_withdrawn",
        "summary": "Receive policy.withdrawn events",
        "description": "Contract event payload projected from policy.withdraw. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "policy.withdrawn",
        "x-hyperscale-operation": "policy.withdraw",
        "x-hyperscale-operation-id": "policy_withdraw",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "policy.withdrawn"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.abandoned": {
      "x-hyperscale-event-type": "sale_settlement.abandoned",
      "x-hyperscale-operation": "sale_settlement.abandon",
      "x-hyperscale-operation-id": "sale_settlement_abandon",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_abandoned",
        "summary": "Receive sale_settlement.abandoned events",
        "description": "Contract event payload projected from sale_settlement.abandon. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.abandoned",
        "x-hyperscale-operation": "sale_settlement.abandon",
        "x-hyperscale-operation-id": "sale_settlement_abandon",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.abandoned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.cancelled": {
      "x-hyperscale-event-type": "sale_settlement.cancelled",
      "x-hyperscale-operation": "sale_settlement.cancel",
      "x-hyperscale-operation-id": "sale_settlement_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_cancelled",
        "summary": "Receive sale_settlement.cancelled events",
        "description": "Contract event payload projected from sale_settlement.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.cancelled",
        "x-hyperscale-operation": "sale_settlement.cancel",
        "x-hyperscale-operation-id": "sale_settlement_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.cancelled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.created": {
      "x-hyperscale-event-type": "sale_settlement.created",
      "x-hyperscale-operation": "sale_settlement.create",
      "x-hyperscale-operation-id": "sale_settlement_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_created",
        "summary": "Receive sale_settlement.created events",
        "description": "Contract event payload projected from sale_settlement.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.created",
        "x-hyperscale-operation": "sale_settlement.create",
        "x-hyperscale-operation-id": "sale_settlement_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.handover_confirmed": {
      "x-hyperscale-event-type": "sale_settlement.handover_confirmed",
      "x-hyperscale-operation": "sale_settlement.confirm_handover",
      "x-hyperscale-operation-id": "sale_settlement_confirm_handover",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_handover_confirmed",
        "summary": "Receive sale_settlement.handover_confirmed events",
        "description": "Contract event payload projected from sale_settlement.confirm_handover. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.handover_confirmed",
        "x-hyperscale-operation": "sale_settlement.confirm_handover",
        "x-hyperscale-operation-id": "sale_settlement_confirm_handover",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.handover_confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_1_funded": {
      "x-hyperscale-event-type": "sale_settlement.piece_1_funded",
      "x-hyperscale-operation": "sale_settlement.fund_piece_1",
      "x-hyperscale-operation-id": "sale_settlement_fund_piece_1",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_1_funded",
        "summary": "Receive sale_settlement.piece_1_funded events",
        "description": "Contract event payload projected from sale_settlement.fund_piece_1. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_1_funded",
        "x-hyperscale-operation": "sale_settlement.fund_piece_1",
        "x-hyperscale-operation-id": "sale_settlement_fund_piece_1",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_1_funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_1_unfunded": {
      "x-hyperscale-event-type": "sale_settlement.piece_1_unfunded",
      "x-hyperscale-operation": "sale_settlement.unfund_piece_1",
      "x-hyperscale-operation-id": "sale_settlement_unfund_piece_1",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_1_unfunded",
        "summary": "Receive sale_settlement.piece_1_unfunded events",
        "description": "Contract event payload projected from sale_settlement.unfund_piece_1. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_1_unfunded",
        "x-hyperscale-operation": "sale_settlement.unfund_piece_1",
        "x-hyperscale-operation-id": "sale_settlement_unfund_piece_1",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_1_unfunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_2_funded": {
      "x-hyperscale-event-type": "sale_settlement.piece_2_funded",
      "x-hyperscale-operation": "sale_settlement.fund_piece_2",
      "x-hyperscale-operation-id": "sale_settlement_fund_piece_2",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_2_funded",
        "summary": "Receive sale_settlement.piece_2_funded events",
        "description": "Contract event payload projected from sale_settlement.fund_piece_2. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_2_funded",
        "x-hyperscale-operation": "sale_settlement.fund_piece_2",
        "x-hyperscale-operation-id": "sale_settlement_fund_piece_2",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_2_funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_2_refunded": {
      "x-hyperscale-event-type": "sale_settlement.piece_2_refunded",
      "x-hyperscale-operation": "sale_settlement.refund_piece_2",
      "x-hyperscale-operation-id": "sale_settlement_refund_piece_2",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_2_refunded",
        "summary": "Receive sale_settlement.piece_2_refunded events",
        "description": "Contract event payload projected from sale_settlement.refund_piece_2. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_2_refunded",
        "x-hyperscale-operation": "sale_settlement.refund_piece_2",
        "x-hyperscale-operation-id": "sale_settlement_refund_piece_2",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_2_refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_2_released": {
      "x-hyperscale-event-type": "sale_settlement.piece_2_released",
      "x-hyperscale-operation": "sale_settlement.release_piece_2",
      "x-hyperscale-operation-id": "sale_settlement_release_piece_2",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_2_released",
        "summary": "Receive sale_settlement.piece_2_released events",
        "description": "Contract event payload projected from sale_settlement.release_piece_2. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_2_released",
        "x-hyperscale-operation": "sale_settlement.release_piece_2",
        "x-hyperscale-operation-id": "sale_settlement_release_piece_2",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_2_released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_2_unfunded": {
      "x-hyperscale-event-type": "sale_settlement.piece_2_unfunded",
      "x-hyperscale-operation": "sale_settlement.unfund_piece_2",
      "x-hyperscale-operation-id": "sale_settlement_unfund_piece_2",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_2_unfunded",
        "summary": "Receive sale_settlement.piece_2_unfunded events",
        "description": "Contract event payload projected from sale_settlement.unfund_piece_2. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_2_unfunded",
        "x-hyperscale-operation": "sale_settlement.unfund_piece_2",
        "x-hyperscale-operation-id": "sale_settlement_unfund_piece_2",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_2_unfunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_3_funded": {
      "x-hyperscale-event-type": "sale_settlement.piece_3_funded",
      "x-hyperscale-operation": "sale_settlement.fund_piece_3",
      "x-hyperscale-operation-id": "sale_settlement_fund_piece_3",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_3_funded",
        "summary": "Receive sale_settlement.piece_3_funded events",
        "description": "Contract event payload projected from sale_settlement.fund_piece_3. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_3_funded",
        "x-hyperscale-operation": "sale_settlement.fund_piece_3",
        "x-hyperscale-operation-id": "sale_settlement_fund_piece_3",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_3_funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_3_refunded": {
      "x-hyperscale-event-type": "sale_settlement.piece_3_refunded",
      "x-hyperscale-operation": "sale_settlement.refund_piece_3",
      "x-hyperscale-operation-id": "sale_settlement_refund_piece_3",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_3_refunded",
        "summary": "Receive sale_settlement.piece_3_refunded events",
        "description": "Contract event payload projected from sale_settlement.refund_piece_3. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_3_refunded",
        "x-hyperscale-operation": "sale_settlement.refund_piece_3",
        "x-hyperscale-operation-id": "sale_settlement_refund_piece_3",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_3_refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_3_released": {
      "x-hyperscale-event-type": "sale_settlement.piece_3_released",
      "x-hyperscale-operation": "sale_settlement.release_piece_3",
      "x-hyperscale-operation-id": "sale_settlement_release_piece_3",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_3_released",
        "summary": "Receive sale_settlement.piece_3_released events",
        "description": "Contract event payload projected from sale_settlement.release_piece_3. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_3_released",
        "x-hyperscale-operation": "sale_settlement.release_piece_3",
        "x-hyperscale-operation-id": "sale_settlement_release_piece_3",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_3_released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.piece_3_unfunded": {
      "x-hyperscale-event-type": "sale_settlement.piece_3_unfunded",
      "x-hyperscale-operation": "sale_settlement.unfund_piece_3",
      "x-hyperscale-operation-id": "sale_settlement_unfund_piece_3",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_piece_3_unfunded",
        "summary": "Receive sale_settlement.piece_3_unfunded events",
        "description": "Contract event payload projected from sale_settlement.unfund_piece_3. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.piece_3_unfunded",
        "x-hyperscale-operation": "sale_settlement.unfund_piece_3",
        "x-hyperscale-operation-id": "sale_settlement_unfund_piece_3",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.piece_3_unfunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sale_settlement.service_fee_collected": {
      "x-hyperscale-event-type": "sale_settlement.service_fee_collected",
      "x-hyperscale-operation": "sale_settlement.collect_service_fee",
      "x-hyperscale-operation-id": "sale_settlement_collect_service_fee",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sale_settlement_service_fee_collected",
        "summary": "Receive sale_settlement.service_fee_collected events",
        "description": "Contract event payload projected from sale_settlement.collect_service_fee. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sale_settlement.service_fee_collected",
        "x-hyperscale-operation": "sale_settlement.collect_service_fee",
        "x-hyperscale-operation-id": "sale_settlement_collect_service_fee",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sale_settlement.service_fee_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sandbox.account.funded": {
      "x-hyperscale-event-type": "sandbox.account.funded",
      "x-hyperscale-operation": "sandbox.account.fund",
      "x-hyperscale-operation-id": "sandbox_account_fund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sandbox_account_funded",
        "summary": "Receive sandbox.account.funded events",
        "description": "Contract event payload projected from sandbox.account.fund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sandbox.account.funded",
        "x-hyperscale-operation": "sandbox.account.fund",
        "x-hyperscale-operation-id": "sandbox_account_fund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sandbox.account.funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sandbox.customer.onboarded": {
      "x-hyperscale-event-type": "sandbox.customer.onboarded",
      "x-hyperscale-operation": "sandbox.customer.onboard",
      "x-hyperscale-operation-id": "sandbox_customer_onboard",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sandbox_customer_onboarded",
        "summary": "Receive sandbox.customer.onboarded events",
        "description": "Contract event payload projected from sandbox.customer.onboard. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sandbox.customer.onboarded",
        "x-hyperscale-operation": "sandbox.customer.onboard",
        "x-hyperscale-operation-id": "sandbox_customer_onboard",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sandbox.customer.onboarded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "sandbox.customer_access.activated": {
      "x-hyperscale-event-type": "sandbox.customer_access.activated",
      "x-hyperscale-operation": "sandbox.customer_access.activate",
      "x-hyperscale-operation-id": "sandbox_customer_access_activate",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_sandbox_customer_access_activated",
        "summary": "Receive sandbox.customer_access.activated events",
        "description": "Contract event payload projected from sandbox.customer_access.activate. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "sandbox.customer_access.activated",
        "x-hyperscale-operation": "sandbox.customer_access.activate",
        "x-hyperscale-operation-id": "sandbox_customer_access_activate",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "sandbox.customer_access.activated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "savings_circle.closed": {
      "x-hyperscale-event-type": "savings_circle.closed",
      "x-hyperscale-operation": "savings_circle.close",
      "x-hyperscale-operation-id": "savings_circle_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_savings_circle_closed",
        "summary": "Receive savings_circle.closed events",
        "description": "Contract event payload projected from savings_circle.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "savings_circle.closed",
        "x-hyperscale-operation": "savings_circle.close",
        "x-hyperscale-operation-id": "savings_circle_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "savings_circle.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "savings_circle.created": {
      "x-hyperscale-event-type": "savings_circle.created",
      "x-hyperscale-operation": "savings_circle.create",
      "x-hyperscale-operation-id": "savings_circle_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_savings_circle_created",
        "summary": "Receive savings_circle.created events",
        "description": "Contract event payload projected from savings_circle.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "savings_circle.created",
        "x-hyperscale-operation": "savings_circle.create",
        "x-hyperscale-operation-id": "savings_circle_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "savings_circle.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "savings_circle.disbanded": {
      "x-hyperscale-event-type": "savings_circle.disbanded",
      "x-hyperscale-operation": "savings_circle.disband",
      "x-hyperscale-operation-id": "savings_circle_disband",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_savings_circle_disbanded",
        "summary": "Receive savings_circle.disbanded events",
        "description": "Contract event payload projected from savings_circle.disband. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "savings_circle.disbanded",
        "x-hyperscale-operation": "savings_circle.disband",
        "x-hyperscale-operation-id": "savings_circle_disband",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "savings_circle.disbanded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "subject.created": {
      "x-hyperscale-event-type": "subject.created",
      "x-hyperscale-operation": "subject.create",
      "x-hyperscale-operation-id": "subject_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_subject_created",
        "summary": "Receive subject.created events",
        "description": "Contract event payload projected from subject.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "subject.created",
        "x-hyperscale-operation": "subject.create",
        "x-hyperscale-operation-id": "subject_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "subject.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trade_settlement.abandoned": {
      "x-hyperscale-event-type": "trade_settlement.abandoned",
      "x-hyperscale-operation": "trade_settlement.abandon",
      "x-hyperscale-operation-id": "trade_settlement_abandon",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trade_settlement_abandoned",
        "summary": "Receive trade_settlement.abandoned events",
        "description": "Contract event payload projected from trade_settlement.abandon. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trade_settlement.abandoned",
        "x-hyperscale-operation": "trade_settlement.abandon",
        "x-hyperscale-operation-id": "trade_settlement_abandon",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trade_settlement.abandoned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trade_settlement.cancelled": {
      "x-hyperscale-event-type": "trade_settlement.cancelled",
      "x-hyperscale-operation": "trade_settlement.cancel",
      "x-hyperscale-operation-id": "trade_settlement_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trade_settlement_cancelled",
        "summary": "Receive trade_settlement.cancelled events",
        "description": "Contract event payload projected from trade_settlement.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trade_settlement.cancelled",
        "x-hyperscale-operation": "trade_settlement.cancel",
        "x-hyperscale-operation-id": "trade_settlement_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trade_settlement.cancelled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trade_settlement.clawed_back": {
      "x-hyperscale-event-type": "trade_settlement.clawed_back",
      "x-hyperscale-operation": "trade_settlement.dispute",
      "x-hyperscale-operation-id": "trade_settlement_dispute",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trade_settlement_clawed_back",
        "summary": "Receive trade_settlement.clawed_back events",
        "description": "Contract event payload projected from trade_settlement.dispute. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trade_settlement.clawed_back",
        "x-hyperscale-operation": "trade_settlement.dispute",
        "x-hyperscale-operation-id": "trade_settlement_dispute",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trade_settlement.clawed_back"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trade_settlement.created": {
      "x-hyperscale-event-type": "trade_settlement.created",
      "x-hyperscale-operation": "trade_settlement.create",
      "x-hyperscale-operation-id": "trade_settlement_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trade_settlement_created",
        "summary": "Receive trade_settlement.created events",
        "description": "Contract event payload projected from trade_settlement.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trade_settlement.created",
        "x-hyperscale-operation": "trade_settlement.create",
        "x-hyperscale-operation-id": "trade_settlement_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trade_settlement.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trade_settlement.funded": {
      "x-hyperscale-event-type": "trade_settlement.funded",
      "x-hyperscale-operation": "trade_settlement.fund",
      "x-hyperscale-operation-id": "trade_settlement_fund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trade_settlement_funded",
        "summary": "Receive trade_settlement.funded events",
        "description": "Contract event payload projected from trade_settlement.fund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trade_settlement.funded",
        "x-hyperscale-operation": "trade_settlement.fund",
        "x-hyperscale-operation-id": "trade_settlement_fund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trade_settlement.funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trade_settlement.released": {
      "x-hyperscale-event-type": "trade_settlement.released",
      "x-hyperscale-operation": "trade_settlement.release",
      "x-hyperscale-operation-id": "trade_settlement_release",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trade_settlement_released",
        "summary": "Receive trade_settlement.released events",
        "description": "Contract event payload projected from trade_settlement.release. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trade_settlement.released",
        "x-hyperscale-operation": "trade_settlement.release",
        "x-hyperscale-operation-id": "trade_settlement_release",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trade_settlement.released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "travel_package.canceled": {
      "x-hyperscale-event-type": "travel_package.canceled",
      "x-hyperscale-operation": "travel_package.cancel",
      "x-hyperscale-operation-id": "travel_package_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_travel_package_canceled",
        "summary": "Receive travel_package.canceled events",
        "description": "Contract event payload projected from travel_package.cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "travel_package.canceled",
        "x-hyperscale-operation": "travel_package.cancel",
        "x-hyperscale-operation-id": "travel_package_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "travel_package.canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "travel_package.completed": {
      "x-hyperscale-event-type": "travel_package.completed",
      "x-hyperscale-operation": "travel_package.complete",
      "x-hyperscale-operation-id": "travel_package_complete",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_travel_package_completed",
        "summary": "Receive travel_package.completed events",
        "description": "Contract event payload projected from travel_package.complete. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "travel_package.completed",
        "x-hyperscale-operation": "travel_package.complete",
        "x-hyperscale-operation-id": "travel_package_complete",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "travel_package.completed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "travel_package.confirmed": {
      "x-hyperscale-event-type": "travel_package.confirmed",
      "x-hyperscale-operation": "travel_package.confirm",
      "x-hyperscale-operation-id": "travel_package_confirm",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_travel_package_confirmed",
        "summary": "Receive travel_package.confirmed events",
        "description": "Contract event payload projected from travel_package.confirm. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "travel_package.confirmed",
        "x-hyperscale-operation": "travel_package.confirm",
        "x-hyperscale-operation-id": "travel_package_confirm",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "travel_package.confirmed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "travel_package.created": {
      "x-hyperscale-event-type": "travel_package.created",
      "x-hyperscale-operation": "travel_package.create",
      "x-hyperscale-operation-id": "travel_package_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_travel_package_created",
        "summary": "Receive travel_package.created events",
        "description": "Contract event payload projected from travel_package.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "travel_package.created",
        "x-hyperscale-operation": "travel_package.create",
        "x-hyperscale-operation-id": "travel_package_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "travel_package.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trust.review.evidence.attached": {
      "x-hyperscale-event-type": "trust.review.evidence.attached",
      "x-hyperscale-operation": "trust_evidence.attach",
      "x-hyperscale-operation-id": "trust_evidence_attach",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trust_review_evidence_attached",
        "summary": "Receive trust.review.evidence.attached events",
        "description": "Contract event payload projected from trust_evidence.attach. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trust.review.evidence.attached",
        "x-hyperscale-operation": "trust_evidence.attach",
        "x-hyperscale-operation-id": "trust_evidence_attach",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trust.review.evidence.attached"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trust.review.requirement.responded": {
      "x-hyperscale-event-type": "trust.review.requirement.responded",
      "x-hyperscale-operation": "trust_requirement.respond",
      "x-hyperscale-operation-id": "trust_requirement_respond",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trust_review_requirement_responded",
        "summary": "Receive trust.review.requirement.responded events",
        "description": "Contract event payload projected from trust_requirement.respond. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trust.review.requirement.responded",
        "x-hyperscale-operation": "trust_requirement.respond",
        "x-hyperscale-operation-id": "trust_requirement_respond",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trust.review.requirement.responded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "trust.review.submitted": {
      "x-hyperscale-event-type": "trust.review.submitted",
      "x-hyperscale-operation": "trust_review.submit",
      "x-hyperscale-operation-id": "trust_review_submit",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_trust_review_submitted",
        "summary": "Receive trust.review.submitted events",
        "description": "Contract event payload projected from trust_review.submit. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "trust.review.submitted",
        "x-hyperscale-operation": "trust_review.submit",
        "x-hyperscale-operation-id": "trust_review_submit",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "trust.review.submitted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.confirm_canceled": {
      "x-hyperscale-event-type": "vehicle_escrow.confirm_canceled",
      "x-hyperscale-operation": "vehicle_escrow.confirm_cancel",
      "x-hyperscale-operation-id": "vehicle_escrow_confirm_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_confirm_canceled",
        "summary": "Receive vehicle_escrow.confirm_canceled events",
        "description": "Contract event payload projected from vehicle_escrow.confirm_cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.confirm_canceled",
        "x-hyperscale-operation": "vehicle_escrow.confirm_cancel",
        "x-hyperscale-operation-id": "vehicle_escrow_confirm_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.confirm_canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.created": {
      "x-hyperscale-event-type": "vehicle_escrow.created",
      "x-hyperscale-operation": "vehicle_escrow.create",
      "x-hyperscale-operation-id": "vehicle_escrow_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_created",
        "summary": "Receive vehicle_escrow.created events",
        "description": "Contract event payload projected from vehicle_escrow.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.created",
        "x-hyperscale-operation": "vehicle_escrow.create",
        "x-hyperscale-operation-id": "vehicle_escrow_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.funded": {
      "x-hyperscale-event-type": "vehicle_escrow.funded",
      "x-hyperscale-operation": "vehicle_escrow.fund",
      "x-hyperscale-operation-id": "vehicle_escrow_fund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_funded",
        "summary": "Receive vehicle_escrow.funded events",
        "description": "Contract event payload projected from vehicle_escrow.fund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.funded",
        "x-hyperscale-operation": "vehicle_escrow.fund",
        "x-hyperscale-operation-id": "vehicle_escrow_fund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.funded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.penalty_collected": {
      "x-hyperscale-event-type": "vehicle_escrow.penalty_collected",
      "x-hyperscale-operation": "vehicle_escrow.collect_penalty",
      "x-hyperscale-operation-id": "vehicle_escrow_collect_penalty",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_penalty_collected",
        "summary": "Receive vehicle_escrow.penalty_collected events",
        "description": "Contract event payload projected from vehicle_escrow.collect_penalty. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.penalty_collected",
        "x-hyperscale-operation": "vehicle_escrow.collect_penalty",
        "x-hyperscale-operation-id": "vehicle_escrow_collect_penalty",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.penalty_collected"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.quote_canceled": {
      "x-hyperscale-event-type": "vehicle_escrow.quote_canceled",
      "x-hyperscale-operation": "vehicle_escrow.quote_cancel",
      "x-hyperscale-operation-id": "vehicle_escrow_quote_cancel",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_quote_canceled",
        "summary": "Receive vehicle_escrow.quote_canceled events",
        "description": "Contract event payload projected from vehicle_escrow.quote_cancel. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.quote_canceled",
        "x-hyperscale-operation": "vehicle_escrow.quote_cancel",
        "x-hyperscale-operation-id": "vehicle_escrow_quote_cancel",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.quote_canceled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.released": {
      "x-hyperscale-event-type": "vehicle_escrow.released",
      "x-hyperscale-operation": "vehicle_escrow.release",
      "x-hyperscale-operation-id": "vehicle_escrow_release",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_released",
        "summary": "Receive vehicle_escrow.released events",
        "description": "Contract event payload projected from vehicle_escrow.release. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.released",
        "x-hyperscale-operation": "vehicle_escrow.release",
        "x-hyperscale-operation-id": "vehicle_escrow_release",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.released"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_escrow.updated": {
      "x-hyperscale-event-type": "vehicle_escrow.updated",
      "x-hyperscale-operation": "vehicle_escrow.update",
      "x-hyperscale-operation-id": "vehicle_escrow_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_escrow_updated",
        "summary": "Receive vehicle_escrow.updated events",
        "description": "Contract event payload projected from vehicle_escrow.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_escrow.updated",
        "x-hyperscale-operation": "vehicle_escrow.update",
        "x-hyperscale-operation-id": "vehicle_escrow_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_escrow.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_listing.completed": {
      "x-hyperscale-event-type": "vehicle_listing.completed",
      "x-hyperscale-operation": "vehicle_listing.complete",
      "x-hyperscale-operation-id": "vehicle_listing_complete",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_listing_completed",
        "summary": "Receive vehicle_listing.completed events",
        "description": "Contract event payload projected from vehicle_listing.complete. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_listing.completed",
        "x-hyperscale-operation": "vehicle_listing.complete",
        "x-hyperscale-operation-id": "vehicle_listing_complete",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_listing.completed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_listing.created": {
      "x-hyperscale-event-type": "vehicle_listing.created",
      "x-hyperscale-operation": "vehicle_listing.create",
      "x-hyperscale-operation-id": "vehicle_listing_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_listing_created",
        "summary": "Receive vehicle_listing.created events",
        "description": "Contract event payload projected from vehicle_listing.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_listing.created",
        "x-hyperscale-operation": "vehicle_listing.create",
        "x-hyperscale-operation-id": "vehicle_listing_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_listing.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_listing.delisted": {
      "x-hyperscale-event-type": "vehicle_listing.delisted",
      "x-hyperscale-operation": "vehicle_listing.delist",
      "x-hyperscale-operation-id": "vehicle_listing_delist",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_listing_delisted",
        "summary": "Receive vehicle_listing.delisted events",
        "description": "Contract event payload projected from vehicle_listing.delist. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_listing.delisted",
        "x-hyperscale-operation": "vehicle_listing.delist",
        "x-hyperscale-operation-id": "vehicle_listing_delist",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_listing.delisted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_listing.reserved": {
      "x-hyperscale-event-type": "vehicle_listing.reserved",
      "x-hyperscale-operation": "vehicle_listing.reserve",
      "x-hyperscale-operation-id": "vehicle_listing_reserve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_listing_reserved",
        "summary": "Receive vehicle_listing.reserved events",
        "description": "Contract event payload projected from vehicle_listing.reserve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_listing.reserved",
        "x-hyperscale-operation": "vehicle_listing.reserve",
        "x-hyperscale-operation-id": "vehicle_listing_reserve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_listing.reserved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_listing.unreserved": {
      "x-hyperscale-event-type": "vehicle_listing.unreserved",
      "x-hyperscale-operation": "vehicle_listing.unreserve",
      "x-hyperscale-operation-id": "vehicle_listing_unreserve",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_listing_unreserved",
        "summary": "Receive vehicle_listing.unreserved events",
        "description": "Contract event payload projected from vehicle_listing.unreserve. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_listing.unreserved",
        "x-hyperscale-operation": "vehicle_listing.unreserve",
        "x-hyperscale-operation-id": "vehicle_listing_unreserve",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_listing.unreserved"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "vehicle_listing.updated": {
      "x-hyperscale-event-type": "vehicle_listing.updated",
      "x-hyperscale-operation": "vehicle_listing.update",
      "x-hyperscale-operation-id": "vehicle_listing_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_vehicle_listing_updated",
        "summary": "Receive vehicle_listing.updated events",
        "description": "Contract event payload projected from vehicle_listing.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "vehicle_listing.updated",
        "x-hyperscale-operation": "vehicle_listing.update",
        "x-hyperscale-operation-id": "vehicle_listing_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "vehicle_listing.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.activated": {
      "x-hyperscale-event-type": "wallet.activated",
      "x-hyperscale-operation": "wallet.activate",
      "x-hyperscale-operation-id": "wallet_activate",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_activated",
        "summary": "Receive wallet.activated events",
        "description": "Contract event payload projected from wallet.activate. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.activated",
        "x-hyperscale-operation": "wallet.activate",
        "x-hyperscale-operation-id": "wallet_activate",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.activated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.closed": {
      "x-hyperscale-event-type": "wallet.closed",
      "x-hyperscale-operation": "wallet.close",
      "x-hyperscale-operation-id": "wallet_close",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_closed",
        "summary": "Receive wallet.closed events",
        "description": "Contract event payload projected from wallet.close. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.closed",
        "x-hyperscale-operation": "wallet.close",
        "x-hyperscale-operation-id": "wallet_close",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.closed"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.created": {
      "x-hyperscale-event-type": "wallet.created",
      "x-hyperscale-operation": "wallet.create",
      "x-hyperscale-operation-id": "wallet_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_created",
        "summary": "Receive wallet.created events",
        "description": "Contract event payload projected from wallet.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.created",
        "x-hyperscale-operation": "wallet.create",
        "x-hyperscale-operation-id": "wallet_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.frozen": {
      "x-hyperscale-event-type": "wallet.frozen",
      "x-hyperscale-operation": "wallet.freeze",
      "x-hyperscale-operation-id": "wallet_freeze",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_frozen",
        "summary": "Receive wallet.frozen events",
        "description": "Contract event payload projected from wallet.freeze. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.frozen",
        "x-hyperscale-operation": "wallet.freeze",
        "x-hyperscale-operation-id": "wallet_freeze",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.frozen"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.topped_up": {
      "x-hyperscale-event-type": "wallet.topped_up",
      "x-hyperscale-operation": "wallet.topup",
      "x-hyperscale-operation-id": "wallet_topup",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_topped_up",
        "summary": "Receive wallet.topped_up events",
        "description": "Contract event payload projected from wallet.topup. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.topped_up",
        "x-hyperscale-operation": "wallet.topup",
        "x-hyperscale-operation-id": "wallet_topup",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.topped_up"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.unfrozen": {
      "x-hyperscale-event-type": "wallet.unfrozen",
      "x-hyperscale-operation": "wallet.unfreeze",
      "x-hyperscale-operation-id": "wallet_unfreeze",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_unfrozen",
        "summary": "Receive wallet.unfrozen events",
        "description": "Contract event payload projected from wallet.unfreeze. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.unfrozen",
        "x-hyperscale-operation": "wallet.unfreeze",
        "x-hyperscale-operation-id": "wallet_unfreeze",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.unfrozen"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.updated": {
      "x-hyperscale-event-type": "wallet.updated",
      "x-hyperscale-operation": "wallet.update",
      "x-hyperscale-operation-id": "wallet_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_updated",
        "summary": "Receive wallet.updated events",
        "description": "Contract event payload projected from wallet.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.updated",
        "x-hyperscale-operation": "wallet.update",
        "x-hyperscale-operation-id": "wallet_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet.withdrawn": {
      "x-hyperscale-event-type": "wallet.withdrawn",
      "x-hyperscale-operation": "wallet.withdraw",
      "x-hyperscale-operation-id": "wallet_withdraw",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_withdrawn",
        "summary": "Receive wallet.withdrawn events",
        "description": "Contract event payload projected from wallet.withdraw. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet.withdrawn",
        "x-hyperscale-operation": "wallet.withdraw",
        "x-hyperscale-operation-id": "wallet_withdraw",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet.withdrawn"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet_spend.created": {
      "x-hyperscale-event-type": "wallet_spend.created",
      "x-hyperscale-operation": "wallet_spend.create",
      "x-hyperscale-operation-id": "wallet_spend_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_spend_created",
        "summary": "Receive wallet_spend.created events",
        "description": "Contract event payload projected from wallet_spend.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet_spend.created",
        "x-hyperscale-operation": "wallet_spend.create",
        "x-hyperscale-operation-id": "wallet_spend_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet_spend.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet_spend.posted": {
      "x-hyperscale-event-type": "wallet_spend.posted",
      "x-hyperscale-operation": "wallet_spend.post",
      "x-hyperscale-operation-id": "wallet_spend_post",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_spend_posted",
        "summary": "Receive wallet_spend.posted events",
        "description": "Contract event payload projected from wallet_spend.post. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet_spend.posted",
        "x-hyperscale-operation": "wallet_spend.post",
        "x-hyperscale-operation-id": "wallet_spend_post",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet_spend.posted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "wallet_spend.refunded": {
      "x-hyperscale-event-type": "wallet_spend.refunded",
      "x-hyperscale-operation": "wallet_spend.refund",
      "x-hyperscale-operation-id": "wallet_spend_refund",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_wallet_spend_refunded",
        "summary": "Receive wallet_spend.refunded events",
        "description": "Contract event payload projected from wallet_spend.refund. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "wallet_spend.refunded",
        "x-hyperscale-operation": "wallet_spend.refund",
        "x-hyperscale-operation-id": "wallet_spend_refund",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "wallet_spend.refunded"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.delivery.resent": {
      "x-hyperscale-event-type": "webhook.delivery.resent",
      "x-hyperscale-operation": "webhook.delivery.resend",
      "x-hyperscale-operation-id": "webhook_delivery_resend",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_delivery_resent",
        "summary": "Receive webhook.delivery.resent events",
        "description": "Contract event payload projected from webhook.delivery.resend. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.delivery.resent",
        "x-hyperscale-operation": "webhook.delivery.resend",
        "x-hyperscale-operation-id": "webhook_delivery_resend",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.delivery.resent"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.created": {
      "x-hyperscale-event-type": "webhook.endpoint.created",
      "x-hyperscale-operation": "webhook.endpoint.create",
      "x-hyperscale-operation-id": "webhook_endpoint_create",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_created",
        "summary": "Receive webhook.endpoint.created events",
        "description": "Contract event payload projected from webhook.endpoint.create. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.created",
        "x-hyperscale-operation": "webhook.endpoint.create",
        "x-hyperscale-operation-id": "webhook_endpoint_create",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.created"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.deleted": {
      "x-hyperscale-event-type": "webhook.endpoint.deleted",
      "x-hyperscale-operation": "webhook.endpoint.delete",
      "x-hyperscale-operation-id": "webhook_endpoint_delete",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_deleted",
        "summary": "Receive webhook.endpoint.deleted events",
        "description": "Contract event payload projected from webhook.endpoint.delete. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.deleted",
        "x-hyperscale-operation": "webhook.endpoint.delete",
        "x-hyperscale-operation-id": "webhook_endpoint_delete",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.deleted"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.disabled": {
      "x-hyperscale-event-type": "webhook.endpoint.disabled",
      "x-hyperscale-operation": "webhook.endpoint.disable",
      "x-hyperscale-operation-id": "webhook_endpoint_disable",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_disabled",
        "summary": "Receive webhook.endpoint.disabled events",
        "description": "Contract event payload projected from webhook.endpoint.disable. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.disabled",
        "x-hyperscale-operation": "webhook.endpoint.disable",
        "x-hyperscale-operation-id": "webhook_endpoint_disable",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.disabled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.enabled": {
      "x-hyperscale-event-type": "webhook.endpoint.enabled",
      "x-hyperscale-operation": "webhook.endpoint.enable",
      "x-hyperscale-operation-id": "webhook_endpoint_enable",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_enabled",
        "summary": "Receive webhook.endpoint.enabled events",
        "description": "Contract event payload projected from webhook.endpoint.enable. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.enabled",
        "x-hyperscale-operation": "webhook.endpoint.enable",
        "x-hyperscale-operation-id": "webhook_endpoint_enable",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.enabled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.recovered": {
      "x-hyperscale-event-type": "webhook.endpoint.recovered",
      "x-hyperscale-operation": "webhook.endpoint.recover",
      "x-hyperscale-operation-id": "webhook_endpoint_recover",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_recovered",
        "summary": "Receive webhook.endpoint.recovered events",
        "description": "Contract event payload projected from webhook.endpoint.recover. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.recovered",
        "x-hyperscale-operation": "webhook.endpoint.recover",
        "x-hyperscale-operation-id": "webhook_endpoint_recover",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.recovered"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.secret.rotated": {
      "x-hyperscale-event-type": "webhook.endpoint.secret.rotated",
      "x-hyperscale-operation": "webhook.endpoint.secret.rotate",
      "x-hyperscale-operation-id": "webhook_endpoint_secret_rotate",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_secret_rotated",
        "summary": "Receive webhook.endpoint.secret.rotated events",
        "description": "Contract event payload projected from webhook.endpoint.secret.rotate. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.secret.rotated",
        "x-hyperscale-operation": "webhook.endpoint.secret.rotate",
        "x-hyperscale-operation-id": "webhook_endpoint_secret_rotate",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.secret.rotated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "webhook.endpoint.updated": {
      "x-hyperscale-event-type": "webhook.endpoint.updated",
      "x-hyperscale-operation": "webhook.endpoint.update",
      "x-hyperscale-operation-id": "webhook_endpoint_update",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_webhook_endpoint_updated",
        "summary": "Receive webhook.endpoint.updated events",
        "description": "Contract event payload projected from webhook.endpoint.update. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "webhook.endpoint.updated",
        "x-hyperscale-operation": "webhook.endpoint.update",
        "x-hyperscale-operation-id": "webhook_endpoint_update",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "webhook.endpoint.updated"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "workspace.earnings.settled": {
      "x-hyperscale-event-type": "workspace.earnings.settled",
      "x-hyperscale-operation": "workspace.earnings.settle",
      "x-hyperscale-operation-id": "workspace_earnings_settle",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_workspace_earnings_settled",
        "summary": "Receive workspace.earnings.settled events",
        "description": "Contract event payload projected from workspace.earnings.settle. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "workspace.earnings.settled",
        "x-hyperscale-operation": "workspace.earnings.settle",
        "x-hyperscale-operation-id": "workspace_earnings_settle",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "workspace.earnings.settled"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    },
    "workspace.treasury.provisioned": {
      "x-hyperscale-event-type": "workspace.treasury.provisioned",
      "x-hyperscale-operation": "workspace.treasury.provision",
      "x-hyperscale-operation-id": "workspace_treasury_provision",
      "x-hyperscale-status": "succeeded",
      "post": {
        "operationId": "webhook_workspace_treasury_provisioned",
        "summary": "Receive workspace.treasury.provisioned events",
        "description": "Contract event payload projected from workspace.treasury.provision. Hyperscale signs each delivery with the webhook-id, webhook-timestamp, and webhook-signature headers.",
        "x-hyperscale-event-type": "workspace.treasury.provisioned",
        "x-hyperscale-operation": "workspace.treasury.provision",
        "x-hyperscale-operation-id": "workspace_treasury_provision",
        "x-hyperscale-status": "succeeded",
        "security": [
          {
            "HyperscaleWebhookSignature": []
          }
        ],
        "parameters": [
          {
            "name": "webhook-id",
            "in": "header",
            "required": true,
            "description": "Immutable Hyperscale event/message identifier and consumer idempotency key included in the signed payload prefix. It matches the JSON body's `id` and remains unchanged across automatic retries, manual resends, expired-lease reclaim, and endpoint recovery. It is not `webhookDeliveryId`, which identifies one delivery attempt for list and resend APIs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "webhook-timestamp",
            "in": "header",
            "required": true,
            "description": "Unix timestamp in seconds included in the signed payload prefix and checked against the receiver tolerance.",
            "schema": {
              "type": "string",
              "pattern": "^\\d+$"
            }
          },
          {
            "name": "webhook-signature",
            "in": "header",
            "required": true,
            "description": "One or more `v1,<base64-hmac-sha256>` signatures for `webhook-id.webhook-timestamp.<raw-body>`.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ExternalWebhookEventEnvelope"
                  },
                  {
                    "type": "object",
                    "required": [
                      "event"
                    ],
                    "properties": {
                      "event": {
                        "type": "string",
                        "const": "workspace.treasury.provisioned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The subscriber accepted the event payload."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AccountBalanceRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "asOf": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "available": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "creditsPending": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "creditsPosted": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "debitsPending": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "debitsPosted": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "normalBalance": {
            "type": "string",
            "enum": [
              "debit",
              "credit"
            ]
          },
          "pending": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "settled": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          }
        },
        "required": [
          "accountId",
          "asOf",
          "available",
          "creditsPending",
          "creditsPosted",
          "currency",
          "debitsPending",
          "debitsPosted",
          "environment",
          "normalBalance",
          "pending",
          "settled",
          "tenantId"
        ],
        "additionalProperties": false
      },
      "AccountCloseBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "AccountCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "enum": [
              "open",
              "frozen"
            ]
          },
          "status": {
            "type": "string",
            "const": "closed"
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "AccountCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "owner": {
            "$ref": "#/components/schemas/AccountCreateInput/$defs/AccountOwner"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "role": {
            "type": "string",
            "enum": [
              "tenant_billing",
              "tenant_credit",
              "tenant_settlement",
              "customer_balance",
              "customer_investment",
              "workspace_pool",
              "workspace_credit",
              "workspace_revenue"
            ]
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "balanceCapMinor": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "metadata": {
            "$ref": "#/components/schemas/AccountCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "owner",
          "role",
          "currency"
        ],
        "additionalProperties": false,
        "$defs": {
          "AccountOwner": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/AccountCreateInput/$defs/TenantAccountOwner"
              },
              {
                "$ref": "#/components/schemas/AccountCreateInput/$defs/CustomerAccountOwner"
              },
              {
                "$ref": "#/components/schemas/AccountCreateInput/$defs/WorkspaceAccountOwner"
              }
            ]
          },
          "TenantAccountOwner": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "tenant"
              },
              "id": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          },
          "CustomerAccountOwner": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "customer"
              },
              "id": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          },
          "WorkspaceAccountOwner": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "workspace"
              },
              "id": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          },
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/AccountCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/AccountCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccountCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/AccountCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "AccountCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "owner": {
            "$ref": "#/components/schemas/AccountCreateOutput/$defs/AccountOwner"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "role": {
            "type": "string",
            "enum": [
              "tenant_billing",
              "tenant_credit",
              "tenant_settlement",
              "customer_balance",
              "customer_investment",
              "workspace_pool",
              "workspace_credit",
              "workspace_revenue"
            ]
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "normalBalance": {
            "type": "string",
            "enum": [
              "debit",
              "credit"
            ]
          },
          "balanceCapMinor": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "status": {
            "type": "string",
            "const": "open"
          }
        },
        "required": [
          "accountId",
          "tenantId",
          "owner",
          "role",
          "currency",
          "normalBalance",
          "status"
        ],
        "additionalProperties": false,
        "$defs": {
          "AccountOwner": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/AccountCreateOutput/$defs/TenantAccountOwner"
              },
              {
                "$ref": "#/components/schemas/AccountCreateOutput/$defs/CustomerAccountOwner"
              },
              {
                "$ref": "#/components/schemas/AccountCreateOutput/$defs/WorkspaceAccountOwner"
              }
            ]
          },
          "TenantAccountOwner": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "tenant"
              },
              "id": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          },
          "CustomerAccountOwner": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "customer"
              },
              "id": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          },
          "WorkspaceAccountOwner": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "const": "workspace"
              },
              "id": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          }
        }
      },
      "AccountFreezeBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "reasonClass": {
            "type": "string",
            "enum": [
              "customer_request"
            ]
          }
        },
        "required": [
          "reason",
          "reasonClass"
        ],
        "additionalProperties": false
      },
      "AccountFreezeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "reasonClass": {
            "type": "string",
            "enum": [
              "customer_request"
            ]
          },
          "previousStatus": {
            "type": "string",
            "const": "open"
          },
          "status": {
            "type": "string",
            "const": "frozen"
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "updatedAt",
          "reason",
          "reasonClass",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "AccountListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "accountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "role": {
                  "type": "string",
                  "enum": [
                    "tenant_billing",
                    "tenant_credit",
                    "tenant_settlement",
                    "tenant_master_mirror",
                    "customer_balance",
                    "customer_investment",
                    "workspace_escrow",
                    "workspace_pool",
                    "workspace_credit",
                    "workspace_revenue",
                    "platform_estate_mirror",
                    "platform_revenue",
                    "provider_payable",
                    "platform_reserve",
                    "platform_suspense"
                  ]
                },
                "currency": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "open",
                    "frozen",
                    "closed"
                  ]
                },
                "ownerParticipantId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "ownerKind": {
                  "type": "string",
                  "enum": [
                    "platform",
                    "tenant",
                    "customer",
                    "workspace",
                    "external"
                  ]
                },
                "ownerCustomerId": {
                  "type": "string",
                  "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Tenant-local customer ID"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "accountId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "AccountRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "role": {
                "type": "string",
                "enum": [
                  "tenant_billing",
                  "tenant_credit",
                  "tenant_settlement",
                  "tenant_master_mirror",
                  "customer_balance",
                  "customer_investment",
                  "workspace_escrow",
                  "workspace_pool",
                  "workspace_credit",
                  "workspace_revenue",
                  "platform_estate_mirror",
                  "platform_revenue",
                  "provider_payable",
                  "platform_reserve",
                  "platform_suspense"
                ]
              },
              "currency": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "open",
                  "frozen",
                  "closed"
                ]
              },
              "ownerParticipantId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ownerKind": {
                "type": "string",
                "enum": [
                  "platform",
                  "tenant",
                  "customer",
                  "workspace",
                  "external"
                ]
              },
              "ownerCustomerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "accountId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "AccountStatementExportOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "closingBalance": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "finalized": {
            "type": "boolean"
          },
          "openingBalance": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "period": {
            "type": "string",
            "pattern": "^(?:19(?:7[0-9]|[89][0-9])|[2-9][0-9]{3})-(0[1-9]|1[0-2])$",
            "description": "UTC calendar month in YYYY-MM form"
          },
          "periodEndExclusive": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "periodStart": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "contentType": {
            "type": "string",
            "const": "text/csv"
          },
          "csv": {
            "type": "string"
          },
          "filename": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "sha256": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "sizeBytes": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "accountId",
          "closingBalance",
          "currency",
          "environment",
          "finalized",
          "openingBalance",
          "period",
          "periodEndExclusive",
          "periodStart",
          "tenantId",
          "contentType",
          "csv",
          "filename",
          "sha256",
          "sizeBytes"
        ],
        "additionalProperties": false
      },
      "AccountStatementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "closingBalance": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "finalized": {
            "type": "boolean"
          },
          "openingBalance": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "period": {
            "type": "string",
            "pattern": "^(?:19(?:7[0-9]|[89][0-9])|[2-9][0-9]{3})-(0[1-9]|1[0-2])$",
            "description": "UTC calendar month in YYYY-MM form"
          },
          "periodEndExclusive": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "periodStart": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "lines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "balanceDelta": {
                  "type": "string",
                  "pattern": "^-?(0|[1-9][0-9]{0,17})$",
                  "description": "Signed minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "counterpartyAccountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "counterpartyDisplayName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 240
                },
                "currency": {
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 3,
                  "pattern": "^[A-Z]{3}$",
                  "description": "ISO 4217 currency code"
                },
                "direction": {
                  "type": "string",
                  "enum": [
                    "debit",
                    "credit"
                  ]
                },
                "entryId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "memo": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 500
                },
                "occurredAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "operationId": {
                  "type": "string",
                  "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale operation ID"
                },
                "operationName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                },
                "origin": {
                  "type": "object",
                  "properties": {
                    "nounId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "nounInstanceId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "verb": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    }
                  },
                  "required": [
                    "nounId",
                    "nounInstanceId",
                    "verb"
                  ],
                  "additionalProperties": false
                },
                "runningBalance": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "posted",
                    "voided"
                  ]
                },
                "transferId": {
                  "type": "string",
                  "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale transfer ID"
                }
              },
              "required": [
                "amount",
                "balanceDelta",
                "counterpartyAccountId",
                "counterpartyDisplayName",
                "currency",
                "direction",
                "entryId",
                "memo",
                "occurredAt",
                "operationId",
                "operationName",
                "runningBalance",
                "status",
                "transferId"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "accountId",
          "closingBalance",
          "currency",
          "environment",
          "finalized",
          "openingBalance",
          "period",
          "periodEndExclusive",
          "periodStart",
          "tenantId",
          "lines"
        ],
        "additionalProperties": false
      },
      "AccountUnfreezeBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "AccountUnfreezeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "const": "frozen"
          },
          "status": {
            "type": "string",
            "const": "open"
          }
        },
        "required": [
          "tenantId",
          "accountId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "ActivityListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "receiptId": {
                      "type": "string",
                      "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale receipt ID"
                    },
                    "requestId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "sourceSurface": {
                      "type": "string",
                      "minLength": 1
                    },
                    "evidence": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "ledger",
                              "local",
                              "external"
                            ]
                          },
                          "reference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "externalConfirmationId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "provider": {
                            "type": "string",
                            "minLength": 1
                          },
                          "providerReference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "resourceKind": {
                            "type": "string",
                            "enum": [
                              "account",
                              "financial_address",
                              "api_key",
                              "audit",
                              "workspace_capability",
                              "charge",
                              "collection",
                              "consent",
                              "credit_balance",
                              "credit_grant",
                              "credit_ledger_entry",
                              "credit_note",
                              "credit_note_line",
                              "customer",
                              "beneficiary",
                              "deposit",
                              "entity",
                              "entity_kyc_profile",
                              "expected_payment",
                              "noun_instance",
                              "operation",
                              "payout",
                              "beneficiary_verification",
                              "workspace",
                              "customer_access",
                              "customer_session",
                              "external_confirmation",
                              "provider_cost_event",
                              "provider_webhook_event",
                              "webhook_endpoint",
                              "webhook_delivery",
                              "receipt",
                              "tenant",
                              "subject",
                              "subject_kind",
                              "statement_line",
                              "reconciliation_run",
                              "reconciliation_break",
                              "reporting_artifact",
                              "str_case",
                              "wedged_money_repair",
                              "reconciliation_break_repair",
                              "attribution_queue",
                              "user_session",
                              "internal_transfer",
                              "usage",
                              "billing_adjustment",
                              "meter_rate_discount",
                              "platform_alert",
                              "platform_rate_override",
                              "billing_period",
                              "billing_subscription",
                              "invoice",
                              "invoice_line",
                              "meter_period_snapshot",
                              "trust_review",
                              "trust_evidence",
                              "trust_requirement",
                              "trust_review_subject",
                              "support_ticket",
                              "support_ticket_message",
                              "support_booking",
                              "support_plan_selection",
                              "tenant_bank_connection"
                            ]
                          },
                          "resourceId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "operationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "operation": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                                "description": "Hyperscale operation ID"
                              },
                              "name": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 120,
                                "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                              },
                              "status": {
                                "type": "string",
                                "minLength": 1
                              }
                            },
                            "required": [
                              "id"
                            ],
                            "additionalProperties": false
                          },
                          "status": {
                            "type": "string",
                            "minLength": 1
                          },
                          "occurredAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          },
                          "proof": {
                            "type": "object",
                            "propertyNames": {
                              "type": "string"
                            },
                            "additionalProperties": {}
                          }
                        },
                        "required": [
                          "kind",
                          "reference"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "errorEnvelope": {
                      "type": "object",
                      "properties": {
                        "code": {
                          "type": "string",
                          "minLength": 1
                        },
                        "message": {
                          "type": "string",
                          "minLength": 1
                        },
                        "status": {
                          "type": "integer",
                          "minimum": 100,
                          "maximum": 599
                        },
                        "details": {}
                      },
                      "required": [
                        "code",
                        "message",
                        "status"
                      ],
                      "additionalProperties": false
                    },
                    "timeline": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "minLength": 1
                          },
                          "reference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "externalConfirmationId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "provider": {
                            "type": "string",
                            "minLength": 1
                          },
                          "providerReference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "resourceKind": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "account",
                                  "financial_address",
                                  "api_key",
                                  "audit",
                                  "workspace_capability",
                                  "charge",
                                  "collection",
                                  "consent",
                                  "credit_balance",
                                  "credit_grant",
                                  "credit_ledger_entry",
                                  "credit_note",
                                  "credit_note_line",
                                  "customer",
                                  "beneficiary",
                                  "deposit",
                                  "entity",
                                  "entity_kyc_profile",
                                  "expected_payment",
                                  "noun_instance",
                                  "operation",
                                  "payout",
                                  "beneficiary_verification",
                                  "workspace",
                                  "customer_access",
                                  "customer_session",
                                  "external_confirmation",
                                  "provider_cost_event",
                                  "provider_webhook_event",
                                  "webhook_endpoint",
                                  "webhook_delivery",
                                  "receipt",
                                  "tenant",
                                  "subject",
                                  "subject_kind",
                                  "statement_line",
                                  "reconciliation_run",
                                  "reconciliation_break",
                                  "reporting_artifact",
                                  "str_case",
                                  "wedged_money_repair",
                                  "reconciliation_break_repair",
                                  "attribution_queue",
                                  "user_session",
                                  "internal_transfer",
                                  "usage",
                                  "billing_adjustment",
                                  "meter_rate_discount",
                                  "platform_alert",
                                  "platform_rate_override",
                                  "billing_period",
                                  "billing_subscription",
                                  "invoice",
                                  "invoice_line",
                                  "meter_period_snapshot",
                                  "trust_review",
                                  "trust_evidence",
                                  "trust_requirement",
                                  "trust_review_subject",
                                  "support_ticket",
                                  "support_ticket_message",
                                  "support_booking",
                                  "support_plan_selection",
                                  "tenant_bank_connection",
                                  "team",
                                  "team_membership",
                                  "user"
                                ]
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "resourceId": {
                            "anyOf": [
                              {
                                "type": "string",
                                "minLength": 1
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "operationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "operation": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                                "description": "Hyperscale operation ID"
                              },
                              "name": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 120,
                                "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                              },
                              "status": {
                                "type": "string",
                                "minLength": 1
                              }
                            },
                            "required": [
                              "id"
                            ],
                            "additionalProperties": false
                          },
                          "status": {
                            "type": "string",
                            "minLength": 1
                          },
                          "occurredAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          },
                          "proof": {
                            "type": "object",
                            "propertyNames": {
                              "type": "string"
                            },
                            "additionalProperties": {}
                          },
                          "usageRecordId": {
                            "type": "string",
                            "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale usage record ID"
                          },
                          "meter": {
                            "type": "string",
                            "enum": [
                              "account.active_month",
                              "account.created.count",
                              "financial_address.issued.count",
                              "financial_address.active_month",
                              "transfer.internal.count",
                              "transfer.internal.volume_sar",
                              "deposit.attributed.count",
                              "deposit.attributed.volume_sar",
                              "payout.external.count",
                              "payout.external.volume_sar",
                              "collection.pay_in.count",
                              "collection.pay_in.volume_sar",
                              "noun.event.count",
                              "noun.event.volume_sar",
                              "kyb.application.review",
                              "verification.kyc.basic.count",
                              "verification.kyc.standard.count",
                              "verification.kyc.investment.count",
                              "verification.kyb.count",
                              "operation.executed.count",
                              "api.read.count",
                              "billing.invoice.settlement",
                              "billing.plan.recurring_month",
                              "billing.product.activation"
                            ]
                          },
                          "quantity": {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                            "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                          },
                          "sourceEventId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "sourceOperationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "workspaceId": {
                            "type": "string",
                            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale workspace ID"
                          },
                          "operationName": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 120,
                            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                          },
                          "receiptId": {
                            "type": "string",
                            "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale receipt ID"
                          },
                          "type": {
                            "type": "string",
                            "minLength": 1
                          },
                          "finalizedAt": {
                            "anyOf": [
                              {
                                "type": "string",
                                "format": "date-time",
                                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "auditEventId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "event": {
                            "type": "string",
                            "minLength": 1
                          },
                          "level": {
                            "type": "string",
                            "minLength": 1
                          },
                          "body": {
                            "type": "object",
                            "propertyNames": {
                              "type": "string"
                            },
                            "additionalProperties": {}
                          }
                        },
                        "required": [
                          "kind"
                        ],
                        "additionalProperties": {}
                      }
                    },
                    "usage": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "usageRecordId": {
                            "type": "string",
                            "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale usage record ID"
                          },
                          "meter": {
                            "type": "string",
                            "enum": [
                              "account.active_month",
                              "account.created.count",
                              "financial_address.issued.count",
                              "financial_address.active_month",
                              "transfer.internal.count",
                              "transfer.internal.volume_sar",
                              "deposit.attributed.count",
                              "deposit.attributed.volume_sar",
                              "payout.external.count",
                              "payout.external.volume_sar",
                              "collection.pay_in.count",
                              "collection.pay_in.volume_sar",
                              "noun.event.count",
                              "noun.event.volume_sar",
                              "kyb.application.review",
                              "verification.kyc.basic.count",
                              "verification.kyc.standard.count",
                              "verification.kyc.investment.count",
                              "verification.kyb.count",
                              "operation.executed.count",
                              "api.read.count",
                              "billing.invoice.settlement",
                              "billing.plan.recurring_month",
                              "billing.product.activation"
                            ]
                          },
                          "quantity": {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                            "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                          },
                          "sourceEventId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "sourceOperationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "workspaceId": {
                            "type": "string",
                            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale workspace ID"
                          },
                          "occurredAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          }
                        },
                        "required": [
                          "usageRecordId",
                          "meter",
                          "quantity",
                          "occurredAt"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "operationId": {
                      "type": "string",
                      "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale operation ID"
                    },
                    "operation": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "accepted",
                        "pending",
                        "succeeded",
                        "failed"
                      ]
                    },
                    "resource": {
                      "type": "object",
                      "properties": {
                        "kind": {
                          "type": "string",
                          "enum": [
                            "account",
                            "financial_address",
                            "api_key",
                            "audit",
                            "workspace_capability",
                            "charge",
                            "collection",
                            "consent",
                            "credit_balance",
                            "credit_grant",
                            "credit_ledger_entry",
                            "credit_note",
                            "credit_note_line",
                            "customer",
                            "beneficiary",
                            "deposit",
                            "entity",
                            "entity_kyc_profile",
                            "expected_payment",
                            "noun_instance",
                            "operation",
                            "payout",
                            "beneficiary_verification",
                            "workspace",
                            "customer_access",
                            "customer_session",
                            "external_confirmation",
                            "provider_cost_event",
                            "provider_webhook_event",
                            "webhook_endpoint",
                            "webhook_delivery",
                            "receipt",
                            "tenant",
                            "subject",
                            "subject_kind",
                            "statement_line",
                            "reconciliation_run",
                            "reconciliation_break",
                            "reporting_artifact",
                            "str_case",
                            "wedged_money_repair",
                            "reconciliation_break_repair",
                            "attribution_queue",
                            "user_session",
                            "internal_transfer",
                            "usage",
                            "billing_adjustment",
                            "meter_rate_discount",
                            "platform_alert",
                            "platform_rate_override",
                            "billing_period",
                            "billing_subscription",
                            "invoice",
                            "invoice_line",
                            "meter_period_snapshot",
                            "trust_review",
                            "trust_evidence",
                            "trust_requirement",
                            "trust_review_subject",
                            "support_ticket",
                            "support_ticket_message",
                            "support_booking",
                            "support_plan_selection",
                            "tenant_bank_connection"
                          ]
                        },
                        "id": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      "required": [
                        "kind"
                      ],
                      "additionalProperties": false
                    },
                    "resourceKind": {
                      "type": "string",
                      "enum": [
                        "account",
                        "financial_address",
                        "api_key",
                        "audit",
                        "workspace_capability",
                        "charge",
                        "collection",
                        "consent",
                        "credit_balance",
                        "credit_grant",
                        "credit_ledger_entry",
                        "credit_note",
                        "credit_note_line",
                        "customer",
                        "beneficiary",
                        "deposit",
                        "entity",
                        "entity_kyc_profile",
                        "expected_payment",
                        "noun_instance",
                        "operation",
                        "payout",
                        "beneficiary_verification",
                        "workspace",
                        "customer_access",
                        "customer_session",
                        "external_confirmation",
                        "provider_cost_event",
                        "provider_webhook_event",
                        "webhook_endpoint",
                        "webhook_delivery",
                        "receipt",
                        "tenant",
                        "subject",
                        "subject_kind",
                        "statement_line",
                        "reconciliation_run",
                        "reconciliation_break",
                        "reporting_artifact",
                        "str_case",
                        "wedged_money_repair",
                        "reconciliation_break_repair",
                        "attribution_queue",
                        "user_session",
                        "internal_transfer",
                        "usage",
                        "billing_adjustment",
                        "meter_rate_discount",
                        "platform_alert",
                        "platform_rate_override",
                        "billing_period",
                        "billing_subscription",
                        "invoice",
                        "invoice_line",
                        "meter_period_snapshot",
                        "trust_review",
                        "trust_evidence",
                        "trust_requirement",
                        "trust_review_subject",
                        "support_ticket",
                        "support_ticket_message",
                        "support_booking",
                        "support_plan_selection",
                        "tenant_bank_connection"
                      ]
                    },
                    "resourceId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "receipt": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                          "description": "Hyperscale receipt ID"
                        },
                        "status": {
                          "type": "string",
                          "minLength": 1
                        },
                        "type": {
                          "type": "string",
                          "minLength": 1
                        },
                        "finalizedAt": {
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time",
                              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "status",
                        "type",
                        "finalizedAt"
                      ],
                      "additionalProperties": false
                    },
                    "auditEvent": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "occurredAt",
                    "evidence",
                    "timeline",
                    "usage",
                    "operationId",
                    "operation",
                    "status"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "receiptId": {
                      "type": "string",
                      "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale receipt ID"
                    },
                    "requestId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "sourceSurface": {
                      "type": "string",
                      "minLength": 1
                    },
                    "evidence": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "ledger",
                              "local",
                              "external"
                            ]
                          },
                          "reference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "externalConfirmationId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "provider": {
                            "type": "string",
                            "minLength": 1
                          },
                          "providerReference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "resourceKind": {
                            "type": "string",
                            "enum": [
                              "account",
                              "financial_address",
                              "api_key",
                              "audit",
                              "workspace_capability",
                              "charge",
                              "collection",
                              "consent",
                              "credit_balance",
                              "credit_grant",
                              "credit_ledger_entry",
                              "credit_note",
                              "credit_note_line",
                              "customer",
                              "beneficiary",
                              "deposit",
                              "entity",
                              "entity_kyc_profile",
                              "expected_payment",
                              "noun_instance",
                              "operation",
                              "payout",
                              "beneficiary_verification",
                              "workspace",
                              "customer_access",
                              "customer_session",
                              "external_confirmation",
                              "provider_cost_event",
                              "provider_webhook_event",
                              "webhook_endpoint",
                              "webhook_delivery",
                              "receipt",
                              "tenant",
                              "subject",
                              "subject_kind",
                              "statement_line",
                              "reconciliation_run",
                              "reconciliation_break",
                              "reporting_artifact",
                              "str_case",
                              "wedged_money_repair",
                              "reconciliation_break_repair",
                              "attribution_queue",
                              "user_session",
                              "internal_transfer",
                              "usage",
                              "billing_adjustment",
                              "meter_rate_discount",
                              "platform_alert",
                              "platform_rate_override",
                              "billing_period",
                              "billing_subscription",
                              "invoice",
                              "invoice_line",
                              "meter_period_snapshot",
                              "trust_review",
                              "trust_evidence",
                              "trust_requirement",
                              "trust_review_subject",
                              "support_ticket",
                              "support_ticket_message",
                              "support_booking",
                              "support_plan_selection",
                              "tenant_bank_connection"
                            ]
                          },
                          "resourceId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "operationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "operation": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                                "description": "Hyperscale operation ID"
                              },
                              "name": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 120,
                                "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                              },
                              "status": {
                                "type": "string",
                                "minLength": 1
                              }
                            },
                            "required": [
                              "id"
                            ],
                            "additionalProperties": false
                          },
                          "status": {
                            "type": "string",
                            "minLength": 1
                          },
                          "occurredAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          },
                          "proof": {
                            "type": "object",
                            "propertyNames": {
                              "type": "string"
                            },
                            "additionalProperties": {}
                          }
                        },
                        "required": [
                          "kind",
                          "reference"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "errorEnvelope": {
                      "type": "object",
                      "properties": {
                        "code": {
                          "type": "string",
                          "minLength": 1
                        },
                        "message": {
                          "type": "string",
                          "minLength": 1
                        },
                        "status": {
                          "type": "integer",
                          "minimum": 100,
                          "maximum": 599
                        },
                        "details": {}
                      },
                      "required": [
                        "code",
                        "message",
                        "status"
                      ],
                      "additionalProperties": false
                    },
                    "timeline": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "minLength": 1
                          },
                          "reference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "externalConfirmationId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "provider": {
                            "type": "string",
                            "minLength": 1
                          },
                          "providerReference": {
                            "type": "string",
                            "minLength": 1
                          },
                          "resourceKind": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "account",
                                  "financial_address",
                                  "api_key",
                                  "audit",
                                  "workspace_capability",
                                  "charge",
                                  "collection",
                                  "consent",
                                  "credit_balance",
                                  "credit_grant",
                                  "credit_ledger_entry",
                                  "credit_note",
                                  "credit_note_line",
                                  "customer",
                                  "beneficiary",
                                  "deposit",
                                  "entity",
                                  "entity_kyc_profile",
                                  "expected_payment",
                                  "noun_instance",
                                  "operation",
                                  "payout",
                                  "beneficiary_verification",
                                  "workspace",
                                  "customer_access",
                                  "customer_session",
                                  "external_confirmation",
                                  "provider_cost_event",
                                  "provider_webhook_event",
                                  "webhook_endpoint",
                                  "webhook_delivery",
                                  "receipt",
                                  "tenant",
                                  "subject",
                                  "subject_kind",
                                  "statement_line",
                                  "reconciliation_run",
                                  "reconciliation_break",
                                  "reporting_artifact",
                                  "str_case",
                                  "wedged_money_repair",
                                  "reconciliation_break_repair",
                                  "attribution_queue",
                                  "user_session",
                                  "internal_transfer",
                                  "usage",
                                  "billing_adjustment",
                                  "meter_rate_discount",
                                  "platform_alert",
                                  "platform_rate_override",
                                  "billing_period",
                                  "billing_subscription",
                                  "invoice",
                                  "invoice_line",
                                  "meter_period_snapshot",
                                  "trust_review",
                                  "trust_evidence",
                                  "trust_requirement",
                                  "trust_review_subject",
                                  "support_ticket",
                                  "support_ticket_message",
                                  "support_booking",
                                  "support_plan_selection",
                                  "tenant_bank_connection",
                                  "team",
                                  "team_membership",
                                  "user"
                                ]
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "resourceId": {
                            "anyOf": [
                              {
                                "type": "string",
                                "minLength": 1
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "operationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "operation": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                                "description": "Hyperscale operation ID"
                              },
                              "name": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 120,
                                "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                              },
                              "status": {
                                "type": "string",
                                "minLength": 1
                              }
                            },
                            "required": [
                              "id"
                            ],
                            "additionalProperties": false
                          },
                          "status": {
                            "type": "string",
                            "minLength": 1
                          },
                          "occurredAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          },
                          "proof": {
                            "type": "object",
                            "propertyNames": {
                              "type": "string"
                            },
                            "additionalProperties": {}
                          },
                          "usageRecordId": {
                            "type": "string",
                            "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale usage record ID"
                          },
                          "meter": {
                            "type": "string",
                            "enum": [
                              "account.active_month",
                              "account.created.count",
                              "financial_address.issued.count",
                              "financial_address.active_month",
                              "transfer.internal.count",
                              "transfer.internal.volume_sar",
                              "deposit.attributed.count",
                              "deposit.attributed.volume_sar",
                              "payout.external.count",
                              "payout.external.volume_sar",
                              "collection.pay_in.count",
                              "collection.pay_in.volume_sar",
                              "noun.event.count",
                              "noun.event.volume_sar",
                              "kyb.application.review",
                              "verification.kyc.basic.count",
                              "verification.kyc.standard.count",
                              "verification.kyc.investment.count",
                              "verification.kyb.count",
                              "operation.executed.count",
                              "api.read.count",
                              "billing.invoice.settlement",
                              "billing.plan.recurring_month",
                              "billing.product.activation"
                            ]
                          },
                          "quantity": {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                            "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                          },
                          "sourceEventId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "sourceOperationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "workspaceId": {
                            "type": "string",
                            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale workspace ID"
                          },
                          "operationName": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 120,
                            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                          },
                          "receiptId": {
                            "type": "string",
                            "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale receipt ID"
                          },
                          "type": {
                            "type": "string",
                            "minLength": 1
                          },
                          "finalizedAt": {
                            "anyOf": [
                              {
                                "type": "string",
                                "format": "date-time",
                                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "auditEventId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "event": {
                            "type": "string",
                            "minLength": 1
                          },
                          "level": {
                            "type": "string",
                            "minLength": 1
                          },
                          "body": {
                            "type": "object",
                            "propertyNames": {
                              "type": "string"
                            },
                            "additionalProperties": {}
                          }
                        },
                        "required": [
                          "kind"
                        ],
                        "additionalProperties": {}
                      }
                    },
                    "usage": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "usageRecordId": {
                            "type": "string",
                            "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale usage record ID"
                          },
                          "meter": {
                            "type": "string",
                            "enum": [
                              "account.active_month",
                              "account.created.count",
                              "financial_address.issued.count",
                              "financial_address.active_month",
                              "transfer.internal.count",
                              "transfer.internal.volume_sar",
                              "deposit.attributed.count",
                              "deposit.attributed.volume_sar",
                              "payout.external.count",
                              "payout.external.volume_sar",
                              "collection.pay_in.count",
                              "collection.pay_in.volume_sar",
                              "noun.event.count",
                              "noun.event.volume_sar",
                              "kyb.application.review",
                              "verification.kyc.basic.count",
                              "verification.kyc.standard.count",
                              "verification.kyc.investment.count",
                              "verification.kyb.count",
                              "operation.executed.count",
                              "api.read.count",
                              "billing.invoice.settlement",
                              "billing.plan.recurring_month",
                              "billing.product.activation"
                            ]
                          },
                          "quantity": {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                            "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                          },
                          "sourceEventId": {
                            "type": "string",
                            "minLength": 1
                          },
                          "sourceOperationId": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "workspaceId": {
                            "type": "string",
                            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale workspace ID"
                          },
                          "occurredAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          }
                        },
                        "required": [
                          "usageRecordId",
                          "meter",
                          "quantity",
                          "occurredAt"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "operationId": {
                      "type": "null"
                    },
                    "resourceKind": {
                      "type": "string",
                      "enum": [
                        "account",
                        "financial_address",
                        "api_key",
                        "audit",
                        "workspace_capability",
                        "charge",
                        "collection",
                        "consent",
                        "credit_balance",
                        "credit_grant",
                        "credit_ledger_entry",
                        "credit_note",
                        "credit_note_line",
                        "customer",
                        "beneficiary",
                        "deposit",
                        "entity",
                        "entity_kyc_profile",
                        "expected_payment",
                        "noun_instance",
                        "operation",
                        "payout",
                        "beneficiary_verification",
                        "workspace",
                        "customer_access",
                        "customer_session",
                        "external_confirmation",
                        "provider_cost_event",
                        "provider_webhook_event",
                        "webhook_endpoint",
                        "webhook_delivery",
                        "receipt",
                        "tenant",
                        "subject",
                        "subject_kind",
                        "statement_line",
                        "reconciliation_run",
                        "reconciliation_break",
                        "reporting_artifact",
                        "str_case",
                        "wedged_money_repair",
                        "reconciliation_break_repair",
                        "attribution_queue",
                        "user_session",
                        "internal_transfer",
                        "usage",
                        "billing_adjustment",
                        "meter_rate_discount",
                        "platform_alert",
                        "platform_rate_override",
                        "billing_period",
                        "billing_subscription",
                        "invoice",
                        "invoice_line",
                        "meter_period_snapshot",
                        "trust_review",
                        "trust_evidence",
                        "trust_requirement",
                        "trust_review_subject",
                        "support_ticket",
                        "support_ticket_message",
                        "support_booking",
                        "support_plan_selection",
                        "tenant_bank_connection",
                        "team",
                        "team_membership",
                        "user"
                      ]
                    },
                    "resourceId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "auditEventId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "auditEvent": {
                      "type": "string",
                      "minLength": 1
                    },
                    "auditEventBody": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "occurredAt",
                    "evidence",
                    "timeline",
                    "usage",
                    "operationId",
                    "auditEventId",
                    "auditEvent"
                  ],
                  "additionalProperties": false
                }
              ]
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "BeneficiaryCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "beneficiaryId": {
            "type": "string",
            "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale beneficiary ID"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 140,
            "description": "Beneficiary name."
          },
          "accountAddress": {
            "type": "string",
            "minLength": 15,
            "maxLength": 34,
            "pattern": "^[A-Z0-9]{15,34}$",
            "description": "Beneficiary account address."
          },
          "metadata": {
            "$ref": "#/components/schemas/BeneficiaryCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "name",
          "accountAddress"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/BeneficiaryCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/BeneficiaryCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/BeneficiaryCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/BeneficiaryCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "BeneficiaryCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "beneficiaryId": {
            "type": "string",
            "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale beneficiary ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 140,
            "description": "Beneficiary name."
          },
          "accountAddress": {
            "type": "string",
            "minLength": 15,
            "maxLength": 34,
            "pattern": "^[A-Z0-9]{15,34}$",
            "description": "Beneficiary account address."
          },
          "status": {
            "type": "string",
            "const": "pending"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "metadata": {
            "$ref": "#/components/schemas/BeneficiaryCreateOutput/$defs/Metadata"
          }
        },
        "required": [
          "beneficiaryId",
          "tenantId",
          "name",
          "accountAddress",
          "status",
          "createdAt",
          "metadata"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/BeneficiaryCreateOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/BeneficiaryCreateOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/BeneficiaryCreateOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/BeneficiaryCreateOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "BeneficiaryListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "beneficiaryId": {
                  "type": "string",
                  "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale beneficiary ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "name": {
                  "type": "string"
                },
                "accountAddress": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "active",
                    "disabled"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "beneficiaryId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "BeneficiaryRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "beneficiaryId": {
                "type": "string",
                "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale beneficiary ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "name": {
                "type": "string"
              },
              "accountAddress": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "active",
                  "disabled"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "beneficiaryId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "BillingAdjustmentListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "billingAdjustmentId": {
                  "type": "string",
                  "pattern": "^badj_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing adjustment ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "direction": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "draft",
                    "applied",
                    "voided"
                  ]
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "billingAdjustmentId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "BillingAdjustmentRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "billingAdjustmentId": {
                "type": "string",
                "pattern": "^badj_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing adjustment ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "direction": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "applied",
                  "voided"
                ]
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "billingAdjustmentId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "BillingPeriodListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "billingPeriodId": {
                  "type": "string",
                  "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing period ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "periodStart": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "periodEnd": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "open",
                    "snapshotted",
                    "finalized",
                    "voided"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "billingPeriodId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "BillingPeriodRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "billingPeriodId": {
                "type": "string",
                "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing period ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "periodStart": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "periodEnd": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "status": {
                "type": "string",
                "enum": [
                  "open",
                  "snapshotted",
                  "finalized",
                  "voided"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "billingPeriodId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "BillingSubscriptionListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "billingSubscriptionId": {
                  "type": "string",
                  "pattern": "^bsub_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing subscription ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "billingPeriodId": {
                  "type": "string",
                  "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing period ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "status": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "startsAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "cancelledAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "billingSubscriptionId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "BillingSubscriptionRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "billingSubscriptionId": {
                "type": "string",
                "pattern": "^bsub_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing subscription ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "billingPeriodId": {
                "type": "string",
                "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing period ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "status": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "cancelledAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "billingSubscriptionId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "BlueprintListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_-]{2,80}$",
                  "description": "Commercial blueprint ID"
                },
                "name": {
                  "type": "string",
                  "minLength": 1
                },
                "summary": {
                  "type": "string",
                  "minLength": 1
                },
                "description": {
                  "type": "string",
                  "minLength": 1
                },
                "sdkNamespace": {
                  "type": "string",
                  "minLength": 1
                },
                "nouns": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1
                      },
                      "title": {
                        "type": "string",
                        "minLength": 1
                      },
                      "summary": {
                        "type": "string",
                        "minLength": 1
                      },
                      "states": {
                        "minItems": 1,
                        "type": "array",
                        "items": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      "verbs": {
                        "minItems": 1,
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "verb": {
                              "type": "string",
                              "minLength": 1
                            },
                            "operation": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 120,
                              "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                            },
                            "firedBy": {
                              "type": "string",
                              "enum": [
                                "machine",
                                "operator",
                                "tenant"
                              ],
                              "description": "Who invokes this action: tenant (a method on your generated SDK), operator (a console session only), or machine (fired by the platform when the action's due-date arrives). Only tenant actions appear in your SDK."
                            },
                            "summary": {
                              "type": "string",
                              "minLength": 1
                            },
                            "from": {
                              "minItems": 1,
                              "type": "array",
                              "items": {
                                "type": "string",
                                "minLength": 1
                              }
                            },
                            "to": {
                              "type": "string",
                              "minLength": 1
                            }
                          },
                          "required": [
                            "verb",
                            "operation",
                            "firedBy",
                            "summary",
                            "to"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "reads": {
                        "minItems": 1,
                        "type": "array",
                        "items": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 120,
                          "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                        }
                      }
                    },
                    "required": [
                      "id",
                      "title",
                      "summary",
                      "states",
                      "verbs",
                      "reads"
                    ],
                    "additionalProperties": false
                  }
                },
                "customNouns": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "minLength": 1
                      },
                      "name": {
                        "type": "string",
                        "minLength": 1
                      },
                      "summary": {
                        "type": "string",
                        "minLength": 1
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "summary"
                    ],
                    "additionalProperties": false
                  }
                },
                "hsx": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "required": [
                "id",
                "name",
                "summary",
                "description",
                "sdkNamespace",
                "nouns",
                "customNouns",
                "hsx"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "BlueprintRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_-]{2,80}$",
            "description": "Commercial blueprint ID"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "summary": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "sdkNamespace": {
            "type": "string",
            "minLength": 1
          },
          "nouns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1
                },
                "title": {
                  "type": "string",
                  "minLength": 1
                },
                "summary": {
                  "type": "string",
                  "minLength": 1
                },
                "states": {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "verbs": {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "verb": {
                        "type": "string",
                        "minLength": 1
                      },
                      "operation": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120,
                        "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                      },
                      "firedBy": {
                        "type": "string",
                        "enum": [
                          "machine",
                          "operator",
                          "tenant"
                        ],
                        "description": "Who invokes this action: tenant (a method on your generated SDK), operator (a console session only), or machine (fired by the platform when the action's due-date arrives). Only tenant actions appear in your SDK."
                      },
                      "summary": {
                        "type": "string",
                        "minLength": 1
                      },
                      "from": {
                        "minItems": 1,
                        "type": "array",
                        "items": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      "to": {
                        "type": "string",
                        "minLength": 1
                      }
                    },
                    "required": [
                      "verb",
                      "operation",
                      "firedBy",
                      "summary",
                      "to"
                    ],
                    "additionalProperties": false
                  }
                },
                "reads": {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 120,
                    "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                  }
                }
              },
              "required": [
                "id",
                "title",
                "summary",
                "states",
                "verbs",
                "reads"
              ],
              "additionalProperties": false
            }
          },
          "customNouns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1
                },
                "name": {
                  "type": "string",
                  "minLength": 1
                },
                "summary": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "required": [
                "id",
                "name",
                "summary"
              ],
              "additionalProperties": false
            }
          },
          "hsx": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "id",
          "name",
          "summary",
          "description",
          "sdkNamespace",
          "nouns",
          "customNouns",
          "hsx"
        ],
        "additionalProperties": false
      },
      "CardActivateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationApproveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card authorization instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_authorization"
          },
          "status": {
            "type": "string",
            "const": "approved"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active card presented for this authorization"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "merchantCategory": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "merchantCountry": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantName",
              "merchantCategory",
              "merchantCountry",
              "merchantReference",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "authorizationTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardAuthorizationId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationCaptureOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card authorization instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_authorization"
          },
          "status": {
            "type": "string",
            "const": "captured"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active card presented for this authorization"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "merchantCategory": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "merchantCountry": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantName",
              "merchantCategory",
              "merchantCountry",
              "merchantReference",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "authorizationTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardAuthorizationId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Active card presented for this authorization"
          },
          "cardAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "settlementAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "merchantName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "merchantCategory": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{1,79}$"
          },
          "merchantCountry": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[A-Z]{2}$",
            "description": "ISO 3166-1 alpha-2 country code"
          },
          "merchantReference": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "workspaceId",
          "cardId",
          "cardAccountId",
          "settlementAccountId",
          "amount",
          "currency",
          "merchantName",
          "merchantCategory",
          "merchantCountry",
          "merchantReference",
          "expiresAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card authorization instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_authorization"
          },
          "status": {
            "type": "string",
            "const": "pending"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active card presented for this authorization"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "merchantCategory": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "merchantCountry": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantName",
              "merchantCategory",
              "merchantCountry",
              "merchantReference",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "authorizationTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardAuthorizationId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationDeclineOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card authorization instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_authorization"
          },
          "status": {
            "type": "string",
            "const": "declined"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active card presented for this authorization"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "merchantCategory": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "merchantCountry": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantName",
              "merchantCategory",
              "merchantCountry",
              "merchantReference",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "authorizationTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardAuthorizationId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cardAuthorizationId": {
                  "type": "string",
                  "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Card authorization instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "card_authorization"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "approved",
                    "captured",
                    "declined",
                    "reversed",
                    "expired"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "cardId": {
                      "type": "string",
                      "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Active card presented for this authorization"
                    },
                    "cardAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "settlementAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "merchantName": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "merchantCategory": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "merchantCountry": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    },
                    "merchantReference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "expiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "cardId",
                    "cardAccountId",
                    "settlementAccountId",
                    "amount",
                    "currency",
                    "merchantName",
                    "merchantCategory",
                    "merchantCountry",
                    "merchantReference",
                    "expiresAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "authorizationTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "cardAuthorizationId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card authorization instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_authorization"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "captured",
              "declined",
              "reversed",
              "expired"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active card presented for this authorization"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "merchantCategory": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "merchantCountry": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantName",
              "merchantCategory",
              "merchantCountry",
              "merchantReference",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "authorizationTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardAuthorizationId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardAuthorizationReverseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card authorization instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_authorization"
          },
          "status": {
            "type": "string",
            "const": "reversed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active card presented for this authorization"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "merchantCategory": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "merchantCountry": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantName",
              "merchantCategory",
              "merchantCountry",
              "merchantReference",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "authorizationTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardAuthorizationId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Active cardholder receiving this card"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "spendControls": {
            "type": "object",
            "properties": {
              "singlePurchaseLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "dailyLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "monthlyLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "allowedMerchantCategories": {
                "maxItems": 64,
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                }
              },
              "allowedCountries": {
                "maxItems": 64,
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 2,
                  "pattern": "^[A-Z]{2}$",
                  "description": "ISO 3166-1 alpha-2 country code"
                }
              }
            },
            "required": [
              "singlePurchaseLimit",
              "dailyLimit",
              "monthlyLimit"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "workspaceId",
          "cardholderId",
          "accountId",
          "currency",
          "label",
          "spendControls"
        ],
        "additionalProperties": false
      },
      "CardCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "const": "issued"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardDisputeCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "cardTransactionId": {
            "type": "string",
            "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Posted card transaction challenged by this dispute"
          },
          "reason": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{1,79}$"
          },
          "evidence": {
            "minItems": 1,
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                },
                "summary": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 1000
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "submittedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "kind",
                "summary",
                "submittedAt"
              ],
              "additionalProperties": false
            }
          },
          "responseDueAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "workspaceId",
          "cardTransactionId",
          "reason",
          "evidence",
          "responseDueAt"
        ],
        "additionalProperties": false
      },
      "CardDisputeCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardDisputeId": {
            "type": "string",
            "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card dispute instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_dispute"
          },
          "status": {
            "type": "string",
            "const": "filed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardTransactionId": {
                "type": "string",
                "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Posted card transaction challenged by this dispute"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card whose transaction is challenged"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "reason": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "evidence": {
                "minItems": 1,
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "summary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1000
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "submittedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "kind",
                    "summary",
                    "submittedAt"
                  ],
                  "additionalProperties": false
                }
              },
              "responseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardTransactionId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "reason",
              "evidence",
              "responseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "disputeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardDisputeId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardDisputeListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cardDisputeId": {
                  "type": "string",
                  "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Card dispute instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "card_dispute"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "filed",
                    "under_review",
                    "won",
                    "lost"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "cardTransactionId": {
                      "type": "string",
                      "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Posted card transaction challenged by this dispute"
                    },
                    "cardId": {
                      "type": "string",
                      "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Card whose transaction is challenged"
                    },
                    "cardAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "settlementAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "reason": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "evidence": {
                      "minItems": 1,
                      "maxItems": 20,
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "pattern": "^[a-z][a-z0-9_]{1,79}$"
                          },
                          "summary": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 1000
                          },
                          "reference": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 180
                          },
                          "submittedAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          }
                        },
                        "required": [
                          "kind",
                          "summary",
                          "submittedAt"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "responseDueAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "cardTransactionId",
                    "cardId",
                    "cardAccountId",
                    "settlementAccountId",
                    "amount",
                    "currency",
                    "reason",
                    "evidence",
                    "responseDueAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "disputeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "cardDisputeId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CardDisputeRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardDisputeId": {
            "type": "string",
            "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card dispute instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_dispute"
          },
          "status": {
            "type": "string",
            "enum": [
              "filed",
              "under_review",
              "won",
              "lost"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardTransactionId": {
                "type": "string",
                "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Posted card transaction challenged by this dispute"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card whose transaction is challenged"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "reason": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "evidence": {
                "minItems": 1,
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "summary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1000
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "submittedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "kind",
                    "summary",
                    "submittedAt"
                  ],
                  "additionalProperties": false
                }
              },
              "responseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardTransactionId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "reason",
              "evidence",
              "responseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "disputeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardDisputeId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardDisputeReviewOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardDisputeId": {
            "type": "string",
            "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card dispute instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_dispute"
          },
          "status": {
            "type": "string",
            "const": "under_review"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardTransactionId": {
                "type": "string",
                "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Posted card transaction challenged by this dispute"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card whose transaction is challenged"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "reason": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "evidence": {
                "minItems": 1,
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "summary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1000
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "submittedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "kind",
                    "summary",
                    "submittedAt"
                  ],
                  "additionalProperties": false
                }
              },
              "responseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardTransactionId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "reason",
              "evidence",
              "responseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "disputeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardDisputeId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardDisputeUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "evidence": {
            "minItems": 1,
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                },
                "summary": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 1000
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "submittedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "kind",
                "summary",
                "submittedAt"
              ],
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "CardDisputeUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardDisputeId": {
            "type": "string",
            "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card dispute instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_dispute"
          },
          "status": {
            "type": "string",
            "enum": [
              "filed",
              "under_review"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardTransactionId": {
                "type": "string",
                "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Posted card transaction challenged by this dispute"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card whose transaction is challenged"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "reason": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "evidence": {
                "minItems": 1,
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "summary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1000
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "submittedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "kind",
                    "summary",
                    "submittedAt"
                  ],
                  "additionalProperties": false
                }
              },
              "responseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardTransactionId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "reason",
              "evidence",
              "responseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "disputeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardDisputeId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardDisputeWinOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardDisputeId": {
            "type": "string",
            "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card dispute instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_dispute"
          },
          "status": {
            "type": "string",
            "const": "won"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardTransactionId": {
                "type": "string",
                "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Posted card transaction challenged by this dispute"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card whose transaction is challenged"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "reason": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "evidence": {
                "minItems": 1,
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "summary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1000
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "submittedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "kind",
                    "summary",
                    "submittedAt"
                  ],
                  "additionalProperties": false
                }
              },
              "responseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardTransactionId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "reason",
              "evidence",
              "responseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "disputeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardDisputeId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardFreezeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "const": "frozen"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cardId": {
                  "type": "string",
                  "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Card instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "card"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "issued",
                    "active",
                    "frozen",
                    "canceled"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "cardholderId": {
                      "type": "string",
                      "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Active cardholder receiving this card"
                    },
                    "accountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "label": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "spendControls": {
                      "type": "object",
                      "properties": {
                        "singlePurchaseLimit": {
                          "type": "string",
                          "pattern": "^[1-9][0-9]{0,17}$",
                          "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                        },
                        "dailyLimit": {
                          "type": "string",
                          "pattern": "^[1-9][0-9]{0,17}$",
                          "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                        },
                        "monthlyLimit": {
                          "type": "string",
                          "pattern": "^[1-9][0-9]{0,17}$",
                          "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                        },
                        "allowedMerchantCategories": {
                          "maxItems": 64,
                          "type": "array",
                          "items": {
                            "type": "string",
                            "pattern": "^[a-z][a-z0-9_]{1,79}$"
                          }
                        },
                        "allowedCountries": {
                          "maxItems": 64,
                          "type": "array",
                          "items": {
                            "type": "string",
                            "minLength": 2,
                            "maxLength": 2,
                            "pattern": "^[A-Z]{2}$",
                            "description": "ISO 3166-1 alpha-2 country code"
                          }
                        }
                      },
                      "required": [
                        "singlePurchaseLimit",
                        "dailyLimit",
                        "monthlyLimit"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "cardholderId",
                    "accountId",
                    "currency",
                    "label",
                    "spendControls"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "cardId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CardRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "enum": [
              "issued",
              "active",
              "frozen",
              "canceled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardTransactionCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "cardAuthorizationId": {
            "type": "string",
            "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Captured authorization settled by this transaction"
          },
          "postedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "workspaceId",
          "cardAuthorizationId",
          "postedAt"
        ],
        "additionalProperties": false
      },
      "CardTransactionCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardTransactionId": {
            "type": "string",
            "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card transaction instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_transaction"
          },
          "status": {
            "type": "string",
            "const": "posted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardAuthorizationId": {
                "type": "string",
                "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Captured authorization settled by this transaction"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card used for this transaction"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "postedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardAuthorizationId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantReference",
              "postedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardTransactionId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardTransactionListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cardTransactionId": {
                  "type": "string",
                  "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Card transaction instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "card_transaction"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "posted",
                    "refunded"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "cardAuthorizationId": {
                      "type": "string",
                      "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Captured authorization settled by this transaction"
                    },
                    "cardId": {
                      "type": "string",
                      "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Card used for this transaction"
                    },
                    "cardAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "settlementAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "merchantReference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "postedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "cardAuthorizationId",
                    "cardId",
                    "cardAccountId",
                    "settlementAccountId",
                    "amount",
                    "currency",
                    "merchantReference",
                    "postedAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "cardTransactionId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CardTransactionRefundBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "CardTransactionRefundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardTransactionId": {
            "type": "string",
            "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card transaction instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_transaction"
          },
          "status": {
            "type": "string",
            "const": "refunded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardAuthorizationId": {
                "type": "string",
                "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Captured authorization settled by this transaction"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card used for this transaction"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "postedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardAuthorizationId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantReference",
              "postedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardTransactionId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardTransactionRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardTransactionId": {
            "type": "string",
            "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card transaction instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card_transaction"
          },
          "status": {
            "type": "string",
            "enum": [
              "posted",
              "refunded"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardAuthorizationId": {
                "type": "string",
                "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Captured authorization settled by this transaction"
              },
              "cardId": {
                "type": "string",
                "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Card used for this transaction"
              },
              "cardAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "settlementAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "merchantReference": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "postedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "cardAuthorizationId",
              "cardId",
              "cardAccountId",
              "settlementAccountId",
              "amount",
              "currency",
              "merchantReference",
              "postedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardTransactionId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardUnfreezeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "spendControls": {
            "type": "object",
            "properties": {
              "singlePurchaseLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "dailyLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "monthlyLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "allowedMerchantCategories": {
                "maxItems": 64,
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                }
              },
              "allowedCountries": {
                "maxItems": 64,
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 2,
                  "pattern": "^[A-Z]{2}$",
                  "description": "ISO 3166-1 alpha-2 country code"
                }
              }
            },
            "required": [
              "singlePurchaseLimit",
              "dailyLimit",
              "monthlyLimit"
            ],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "CardUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardId": {
            "type": "string",
            "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Card instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "card"
          },
          "status": {
            "type": "string",
            "enum": [
              "issued",
              "active",
              "frozen"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "cardholderId": {
                "type": "string",
                "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active cardholder receiving this card"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "spendControls": {
                "type": "object",
                "properties": {
                  "singlePurchaseLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "dailyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "monthlyLimit": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,17}$",
                    "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                  },
                  "allowedMerchantCategories": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    }
                  },
                  "allowedCountries": {
                    "maxItems": 64,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 2,
                      "pattern": "^[A-Z]{2}$",
                      "description": "ISO 3166-1 alpha-2 country code"
                    }
                  }
                },
                "required": [
                  "singlePurchaseLimit",
                  "dailyLimit",
                  "monthlyLimit"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "cardholderId",
              "accountId",
              "currency",
              "label",
              "spendControls"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderActivateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "const": "closed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "displayName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "email": {
            "type": "string",
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "phoneNumber": {
            "type": "string",
            "minLength": 6,
            "maxLength": 32
          }
        },
        "required": [
          "workspaceId",
          "customerId",
          "displayName"
        ],
        "additionalProperties": false
      },
      "CardholderCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "const": "pending"
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "cardholderId": {
                  "type": "string",
                  "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Cardholder instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "cardholder"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "active",
                    "suspended",
                    "closed"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Tenant-local customer ID"
                    },
                    "displayName": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "email": {
                      "type": "string",
                      "format": "email",
                      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
                    },
                    "phoneNumber": {
                      "type": "string",
                      "minLength": 6,
                      "maxLength": 32
                    }
                  },
                  "required": [
                    "customerId",
                    "displayName"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "cardholderId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CardholderResumeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "suspended",
              "closed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderSuspendOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "const": "suspended"
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CardholderUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "email": {
            "type": "string",
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "phoneNumber": {
            "type": "string",
            "minLength": 6,
            "maxLength": 32
          }
        },
        "additionalProperties": false
      },
      "CardholderUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "cardholderId": {
            "type": "string",
            "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Cardholder instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "cardholder"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "suspended"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "email": {
                "type": "string",
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              },
              "phoneNumber": {
                "type": "string",
                "minLength": 6,
                "maxLength": 32
              }
            },
            "required": [
              "customerId",
              "displayName"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "cardholderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ChargeListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "chargeId": {
                  "type": "string",
                  "pattern": "^chg_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale charge ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "description": {
                  "type": "string"
                },
                "billingPeriodId": {
                  "type": "string",
                  "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing period ID"
                },
                "transferId": {
                  "type": "string",
                  "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale transfer ID"
                },
                "debitAccountId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "creditAccountId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "accepted",
                    "posted",
                    "voided",
                    "failed"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "chargeId",
                "tenantId",
                "description",
                "debitAccountId",
                "creditAccountId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ChargeRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "chargeId": {
                "type": "string",
                "pattern": "^chg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale charge ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "description": {
                "type": "string"
              },
              "billingPeriodId": {
                "type": "string",
                "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing period ID"
              },
              "transferId": {
                "type": "string",
                "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale transfer ID"
              },
              "debitAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "creditAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "accepted",
                  "posted",
                  "voided",
                  "failed"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "chargeId",
              "tenantId",
              "description",
              "debitAccountId",
              "creditAccountId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CircleMembershipCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "savingsCircleId": {
            "type": "string",
            "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Savings circle this seat belongs to"
          },
          "memberAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "position": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "receiveAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "payoutAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "joinedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "workspaceId",
          "savingsCircleId",
          "memberAccountId",
          "position",
          "receiveAt",
          "payoutAmount",
          "joinedAt"
        ],
        "additionalProperties": false
      },
      "CircleMembershipCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "circleMembershipId": {
            "type": "string",
            "pattern": "^jmm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Circle membership instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "circle_membership"
          },
          "status": {
            "type": "string",
            "const": "joined"
          },
          "fields": {
            "type": "object",
            "properties": {
              "savingsCircleId": {
                "type": "string",
                "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Savings circle this seat belongs to"
              },
              "memberAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "potAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "contributionAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "termCount": {
                "type": "integer",
                "minimum": 2,
                "maximum": 60
              },
              "position": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "receiveAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "payoutAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "joinedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "savingsCircleId",
              "memberAccountId",
              "potAccountId",
              "contributionAmount",
              "currency",
              "startAt",
              "termCount",
              "position",
              "receiveAt",
              "payoutAmount",
              "joinedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "contributionTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "payoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "circleMembershipId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CircleMembershipListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "circleMembershipId": {
                  "type": "string",
                  "pattern": "^jmm_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Circle membership instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "circle_membership"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "joined",
                    "active",
                    "paid",
                    "withdrawn"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "savingsCircleId": {
                      "type": "string",
                      "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Savings circle this seat belongs to"
                    },
                    "memberAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "potAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "contributionAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "startAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "termCount": {
                      "type": "integer",
                      "minimum": 2,
                      "maximum": 60
                    },
                    "position": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    },
                    "receiveAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "payoutAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "joinedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "savingsCircleId",
                    "memberAccountId",
                    "potAccountId",
                    "contributionAmount",
                    "currency",
                    "startAt",
                    "termCount",
                    "position",
                    "receiveAt",
                    "payoutAmount",
                    "joinedAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "contributionTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "payoutTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "circleMembershipId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CircleMembershipRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "circleMembershipId": {
            "type": "string",
            "pattern": "^jmm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Circle membership instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "circle_membership"
          },
          "status": {
            "type": "string",
            "enum": [
              "joined",
              "active",
              "paid",
              "withdrawn"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "savingsCircleId": {
                "type": "string",
                "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Savings circle this seat belongs to"
              },
              "memberAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "potAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "contributionAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "termCount": {
                "type": "integer",
                "minimum": 2,
                "maximum": 60
              },
              "position": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "receiveAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "payoutAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "joinedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "savingsCircleId",
              "memberAccountId",
              "potAccountId",
              "contributionAmount",
              "currency",
              "startAt",
              "termCount",
              "position",
              "receiveAt",
              "payoutAmount",
              "joinedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "contributionTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "payoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "circleMembershipId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimApproveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "approved"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimAssessOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "assessed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimAttestBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "actorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Account of the party taking this action, asserted by the deciding tenant backend and checked against the instance's party bindings",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          }
        },
        "required": [
          "actorAccountId"
        ],
        "additionalProperties": false
      },
      "ClaimAttestOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "approved"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Active policy this claim is made against"
          },
          "claimantAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "insurerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "claimAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "peril": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{1,79}$"
          },
          "occurredAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "evidenceSummary": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: policy_risk, flight_itinerary, lodging_stay, vehicle, pet, traveler_party, employee_census. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "policyId",
          "claimantAccountId",
          "insurerAccountId",
          "claimAmount",
          "currency",
          "peril",
          "occurredAt",
          "subject"
        ],
        "additionalProperties": false
      },
      "ClaimCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "filed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimDenyOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "denied"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "claimId": {
                  "type": "string",
                  "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Claim instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "claim"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "filed",
                    "assessed",
                    "approved",
                    "paid",
                    "denied"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "policyId": {
                      "type": "string",
                      "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Active policy this claim is made against"
                    },
                    "claimantAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "insurerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "claimAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "evidenceSummary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  },
                  "required": [
                    "policyId",
                    "claimantAccountId",
                    "insurerAccountId",
                    "claimAmount",
                    "currency",
                    "peril",
                    "occurredAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "claimTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "claimId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ClaimPayOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "paid"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "enum": [
              "filed",
              "assessed",
              "approved",
              "paid",
              "denied"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimReverseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "const": "denied"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ClaimUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "evidenceSummary": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "additionalProperties": false
      },
      "ClaimUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "claimId": {
            "type": "string",
            "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Claim instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "claim"
          },
          "status": {
            "type": "string",
            "enum": [
              "filed",
              "assessed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Active policy this claim is made against"
              },
              "claimantAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "claimAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "peril": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,79}$"
              },
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "evidenceSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "policyId",
              "claimantAccountId",
              "insurerAccountId",
              "claimAmount",
              "currency",
              "peril",
              "occurredAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "claimId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "collectionId": {
                  "type": "string",
                  "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale collection ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "reserved",
                    "captured",
                    "cancelled",
                    "failed"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "collectionId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CollectionPayInCancelBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "transferId",
          "reason"
        ],
        "additionalProperties": false
      },
      "CollectionPayInCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionId": {
            "type": "string",
            "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale collection ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "status": {
            "type": "string",
            "const": "cancelled"
          }
        },
        "required": [
          "collectionId",
          "tenantId",
          "transferId",
          "status"
        ],
        "additionalProperties": false
      },
      "CollectionPayInCaptureBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "capturedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "transferId",
          "capturedAt"
        ],
        "additionalProperties": false
      },
      "CollectionPayInCaptureOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionId": {
            "type": "string",
            "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale collection ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "status": {
            "type": "string",
            "const": "captured"
          }
        },
        "required": [
          "collectionId",
          "tenantId",
          "transferId",
          "status"
        ],
        "additionalProperties": false
      },
      "CollectionPayInReserveInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionId": {
            "type": "string",
            "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale collection ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency"
        ],
        "additionalProperties": false
      },
      "CollectionPayInReserveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionId": {
            "type": "string",
            "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale collection ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "status": {
            "type": "string",
            "const": "reserved"
          }
        },
        "required": [
          "collectionId",
          "tenantId",
          "transferId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "status"
        ],
        "additionalProperties": false
      },
      "CollectionRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "collectionId": {
                "type": "string",
                "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale collection ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "reserved",
                  "captured",
                  "cancelled",
                  "failed"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "collectionId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseAgreePlanOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "const": "plan_agreed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseAssignOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "const": "assigned"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "agreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement this case collects against"
          },
          "triggeringInstallmentId": {
            "type": "string",
            "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Overdue installment whose delinquency opened this case"
          },
          "debtorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "recoveryAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "referredAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "maxContactAttemptsPer30Days": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10
          },
          "allowedContactStartHour": {
            "type": "integer",
            "minimum": 0,
            "maximum": 23
          },
          "allowedContactEndHour": {
            "type": "integer",
            "minimum": 0,
            "maximum": 23
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "agreementId",
          "triggeringInstallmentId",
          "debtorAccountId",
          "recoveryAccountId",
          "referredAmount",
          "currency",
          "maxContactAttemptsPer30Days"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "const": "opened"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "collectionsCaseId": {
                  "type": "string",
                  "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Collections case instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "collections_case"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "opened",
                    "assigned",
                    "recovered",
                    "plan_agreed",
                    "recalled",
                    "returned_uncollected"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "agreementId": {
                      "type": "string",
                      "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Credit agreement this case collects against"
                    },
                    "triggeringInstallmentId": {
                      "type": "string",
                      "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Overdue installment whose delinquency opened this case"
                    },
                    "debtorAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "recoveryAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "referredAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "maxContactAttemptsPer30Days": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "allowedContactStartHour": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 23
                    },
                    "allowedContactEndHour": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 23
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "agreementId",
                    "triggeringInstallmentId",
                    "debtorAccountId",
                    "recoveryAccountId",
                    "referredAmount",
                    "currency",
                    "maxContactAttemptsPer30Days"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "recoveryTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "recoveredAmount": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "collectionsCaseId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseRecallOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "const": "recalled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseRecoverBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "recoveredAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          }
        },
        "required": [
          "recoveredAmount"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseRecoverOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "const": "recovered"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "enum": [
              "opened",
              "assigned",
              "recovered",
              "plan_agreed",
              "recalled",
              "returned_uncollected"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseReturnUncollectedOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "const": "returned_uncollected"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CollectionsCaseUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "CollectionsCaseUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "collectionsCaseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "collections_case"
          },
          "status": {
            "type": "string",
            "enum": [
              "opened",
              "assigned"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this case collects against"
              },
              "triggeringInstallmentId": {
                "type": "string",
                "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Overdue installment whose delinquency opened this case"
              },
              "debtorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "recoveryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "referredAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "maxContactAttemptsPer30Days": {
                "type": "integer",
                "minimum": 0,
                "maximum": 10
              },
              "allowedContactStartHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "allowedContactEndHour": {
                "type": "integer",
                "minimum": 0,
                "maximum": 23
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "triggeringInstallmentId",
              "debtorAccountId",
              "recoveryAccountId",
              "referredAmount",
              "currency",
              "maxContactAttemptsPer30Days"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "recoveryTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "recoveredAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "collectionsCaseId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ConsentListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "consentId": {
                  "type": "string",
                  "pattern": "^cns_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale customer consent ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "subjectId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180
                },
                "subjectKind": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "active",
                    "expired",
                    "revoked"
                  ]
                },
                "version": {
                  "type": "string"
                },
                "expiresAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "consentId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ConsentRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "consentId": {
                "type": "string",
                "pattern": "^cns_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale customer consent ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "subjectId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subjectKind": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "active",
                  "expired",
                  "revoked"
                ]
              },
              "version": {
                "type": "string"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "consentId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "ConsentRevokeBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "workspaceId",
          "reason"
        ],
        "additionalProperties": false
      },
      "ConsentRevokeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "consentId": {
            "type": "string",
            "pattern": "^cns_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer consent ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "subjectKind": {
            "type": "string",
            "enum": [
              "customer",
              "customer_access",
              "entity"
            ]
          },
          "subjectId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "status": {
            "type": "string",
            "const": "revoked"
          },
          "revokedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "consentId",
          "tenantId",
          "workspaceId",
          "subjectKind",
          "subjectId",
          "status",
          "revokedAt",
          "reason"
        ],
        "additionalProperties": false
      },
      "ContactAttemptCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "caseId": {
            "type": "string",
            "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collections case this attempt is ledgered under"
          },
          "channel": {
            "type": "string",
            "enum": [
              "sms",
              "email",
              "call",
              "letter"
            ]
          },
          "attemptedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "outcome": {
            "type": "string",
            "enum": [
              "reached",
              "no_answer",
              "promise_to_pay"
            ]
          },
          "note": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "caseId",
          "channel",
          "attemptedAt",
          "outcome"
        ],
        "additionalProperties": false
      },
      "ContactAttemptCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "contactAttemptId": {
            "type": "string",
            "pattern": "^catt_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Contact attempt instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "contact_attempt"
          },
          "status": {
            "type": "string",
            "const": "recorded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "caseId": {
                "type": "string",
                "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Collections case this attempt is ledgered under"
              },
              "channel": {
                "type": "string",
                "enum": [
                  "sms",
                  "email",
                  "call",
                  "letter"
                ]
              },
              "attemptedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "outcome": {
                "type": "string",
                "enum": [
                  "reached",
                  "no_answer",
                  "promise_to_pay"
                ]
              },
              "note": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "caseId",
              "channel",
              "attemptedAt",
              "outcome"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "contactAttemptId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ContactAttemptListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "contactAttemptId": {
                  "type": "string",
                  "pattern": "^catt_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Contact attempt instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "contact_attempt"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "recorded",
                    "voided"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "caseId": {
                      "type": "string",
                      "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Collections case this attempt is ledgered under"
                    },
                    "channel": {
                      "type": "string",
                      "enum": [
                        "sms",
                        "email",
                        "call",
                        "letter"
                      ]
                    },
                    "attemptedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "outcome": {
                      "type": "string",
                      "enum": [
                        "reached",
                        "no_answer",
                        "promise_to_pay"
                      ]
                    },
                    "note": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "caseId",
                    "channel",
                    "attemptedAt",
                    "outcome"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "contactAttemptId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ContactAttemptRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "contactAttemptId": {
            "type": "string",
            "pattern": "^catt_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Contact attempt instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "contact_attempt"
          },
          "status": {
            "type": "string",
            "enum": [
              "recorded",
              "voided"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "caseId": {
                "type": "string",
                "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Collections case this attempt is ledgered under"
              },
              "channel": {
                "type": "string",
                "enum": [
                  "sms",
                  "email",
                  "call",
                  "letter"
                ]
              },
              "attemptedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "outcome": {
                "type": "string",
                "enum": [
                  "reached",
                  "no_answer",
                  "promise_to_pay"
                ]
              },
              "note": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "caseId",
              "channel",
              "attemptedAt",
              "outcome"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "contactAttemptId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ContactAttemptVoidOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "contactAttemptId": {
            "type": "string",
            "pattern": "^catt_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Contact attempt instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "contact_attempt"
          },
          "status": {
            "type": "string",
            "const": "voided"
          },
          "fields": {
            "type": "object",
            "properties": {
              "caseId": {
                "type": "string",
                "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Collections case this attempt is ledgered under"
              },
              "channel": {
                "type": "string",
                "enum": [
                  "sms",
                  "email",
                  "call",
                  "letter"
                ]
              },
              "attemptedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "outcome": {
                "type": "string",
                "enum": [
                  "reached",
                  "no_answer",
                  "promise_to_pay"
                ]
              },
              "note": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "caseId",
              "channel",
              "attemptedAt",
              "outcome"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "contactAttemptId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementAdvanceBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          }
        },
        "additionalProperties": false
      },
      "CreditAgreementAdvanceOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "const": "advanced"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "borrowerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "fundingAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "principal": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "annualRateBps": {
            "type": "integer",
            "minimum": 0,
            "maximum": 20000
          },
          "aprBps": {
            "type": "integer",
            "minimum": 0,
            "maximum": 20000
          },
          "termMonths": {
            "type": "integer",
            "minimum": 1,
            "maximum": 360
          },
          "supersedesAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Closed credit agreement this one supersedes"
          },
          "exposureArrangementId": {
            "type": "string",
            "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Exposure arrangement whose caps bound this agreement"
          },
          "fundingRoundId": {
            "type": "string",
            "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding round whose collected pledges fund this agreement"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "borrowerAccountId",
          "fundingAccountId",
          "principal",
          "currency"
        ],
        "additionalProperties": false
      },
      "CreditAgreementCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "creditAgreementId": {
                  "type": "string",
                  "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Credit agreement instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "credit_agreement"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "advanced",
                    "settled",
                    "written_off",
                    "closed_rescheduled",
                    "closed_refinanced"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "borrowerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "fundingAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "principal": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "annualRateBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 20000
                    },
                    "aprBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 20000
                    },
                    "termMonths": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 360
                    },
                    "supersedesAgreementId": {
                      "type": "string",
                      "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Closed credit agreement this one supersedes"
                    },
                    "exposureArrangementId": {
                      "type": "string",
                      "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Exposure arrangement whose caps bound this agreement"
                    },
                    "fundingRoundId": {
                      "type": "string",
                      "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Funding round whose collected pledges fund this agreement"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "borrowerAccountId",
                    "fundingAccountId",
                    "principal",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "advanceTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "settleTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "advanceAmount": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "advancedTotal": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "settleAmount": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "creditAgreementId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CreditAgreementRefinanceBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "carriedDues": {
            "type": "string",
            "enum": [
              "capitalized",
              "written_off"
            ]
          }
        },
        "required": [
          "carriedDues"
        ],
        "additionalProperties": false
      },
      "CreditAgreementRefinanceOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "const": "closed_refinanced"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementRescheduleBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "carriedDues": {
            "type": "string",
            "enum": [
              "capitalized",
              "written_off"
            ]
          }
        },
        "required": [
          "carriedDues"
        ],
        "additionalProperties": false
      },
      "CreditAgreementRescheduleOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "const": "closed_rescheduled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "advanced",
              "settled",
              "written_off",
              "closed_rescheduled",
              "closed_refinanced"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementSettleOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "const": "settled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "CreditAgreementUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "advanced"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditAgreementWriteOffOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "credit_agreement"
          },
          "status": {
            "type": "string",
            "const": "written_off"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "principal": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "annualRateBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "aprBps": {
                "type": "integer",
                "minimum": 0,
                "maximum": 20000
              },
              "termMonths": {
                "type": "integer",
                "minimum": 1,
                "maximum": 360
              },
              "supersedesAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Closed credit agreement this one supersedes"
              },
              "exposureArrangementId": {
                "type": "string",
                "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Exposure arrangement whose caps bound this agreement"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round whose collected pledges fund this agreement"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "fundingAccountId",
              "principal",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "advanceTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advanceAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "advancedTotal": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "settleAmount": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "creditAgreementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "CreditBalanceListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "creditBalanceId": {
                  "type": "string",
                  "pattern": "^cbal_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing credit balance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "customerId": {
                  "type": "string",
                  "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Tenant-local customer ID"
                },
                "currency": {
                  "type": "string"
                },
                "availableAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "creditBalanceId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CreditBalanceRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "creditBalanceId": {
                "type": "string",
                "pattern": "^cbal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing credit balance ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "currency": {
                "type": "string"
              },
              "availableAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditBalanceId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CreditGrantListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "creditGrantId": {
                  "type": "string",
                  "pattern": "^cgr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing credit grant ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "creditBalanceId": {
                  "type": "string",
                  "pattern": "^cbal_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing credit balance ID"
                },
                "customerId": {
                  "type": "string",
                  "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Tenant-local customer ID"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "remainingAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "creditGrantId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CreditGrantRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "creditGrantId": {
                "type": "string",
                "pattern": "^cgr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing credit grant ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "creditBalanceId": {
                "type": "string",
                "pattern": "^cbal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing credit balance ID"
              },
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "remainingAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditGrantId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CreditLedgerEntryListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "creditLedgerEntryId": {
                  "type": "string",
                  "pattern": "^cled_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing credit ledger entry ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "creditBalanceId": {
                  "type": "string",
                  "pattern": "^cbal_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing credit balance ID"
                },
                "creditGrantId": {
                  "type": "string",
                  "pattern": "^cgr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing credit grant ID"
                },
                "invoiceId": {
                  "type": "string",
                  "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice ID"
                },
                "entryType": {
                  "type": "string"
                },
                "direction": {
                  "type": "string"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "balanceAfter": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "creditLedgerEntryId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CreditLedgerEntryRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "creditLedgerEntryId": {
                "type": "string",
                "pattern": "^cled_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing credit ledger entry ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "creditBalanceId": {
                "type": "string",
                "pattern": "^cbal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing credit balance ID"
              },
              "creditGrantId": {
                "type": "string",
                "pattern": "^cgr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing credit grant ID"
              },
              "invoiceId": {
                "type": "string",
                "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice ID"
              },
              "entryType": {
                "type": "string"
              },
              "direction": {
                "type": "string"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "balanceAfter": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditLedgerEntryId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CreditNoteLineListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "creditNoteLineId": {
                  "type": "string",
                  "pattern": "^cnl_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale credit note line ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "creditNoteId": {
                  "type": "string",
                  "pattern": "^cnote_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale credit note ID"
                },
                "invoiceId": {
                  "type": "string",
                  "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice ID"
                },
                "invoiceLineId": {
                  "type": "string",
                  "pattern": "^invl_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice line ID"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "creditNoteLineId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CreditNoteLineRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "creditNoteLineId": {
                "type": "string",
                "pattern": "^cnl_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale credit note line ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "creditNoteId": {
                "type": "string",
                "pattern": "^cnote_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale credit note ID"
              },
              "invoiceId": {
                "type": "string",
                "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice ID"
              },
              "invoiceLineId": {
                "type": "string",
                "pattern": "^invl_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice line ID"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditNoteLineId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CreditNoteListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "creditNoteId": {
                  "type": "string",
                  "pattern": "^cnote_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale credit note ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "invoiceId": {
                  "type": "string",
                  "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice ID"
                },
                "number": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "issued"
                  ]
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "issuedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "creditNoteId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CreditNoteRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "creditNoteId": {
                "type": "string",
                "pattern": "^cnote_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale credit note ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "invoiceId": {
                "type": "string",
                "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice ID"
              },
              "number": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "issued"
                ]
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "issuedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditNoteId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CustomerAccessCloseBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "CustomerAccessCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "suspended"
            ]
          },
          "status": {
            "type": "string",
            "const": "closed"
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "customerId",
          "customerAccessId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "CustomerAccessListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customerAccessId": {
                  "type": "string",
                  "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale customer access ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "customerId": {
                  "type": "string",
                  "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Tenant-local customer ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "active",
                    "suspended",
                    "closed"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "customerAccessId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CustomerAccessReactivateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "CustomerAccessReactivateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "const": "suspended"
          },
          "status": {
            "type": "string",
            "const": "active"
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "customerId",
          "customerAccessId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "CustomerAccessRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "customerAccessId": {
                "type": "string",
                "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale customer access ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "active",
                  "suspended",
                  "closed"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "customerAccessId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CustomerAccessSuspendBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "CustomerAccessSuspendOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "const": "active"
          },
          "status": {
            "type": "string",
            "const": "suspended"
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "customerId",
          "customerAccessId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "CustomerCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "entity": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "person",
                  "organization"
                ]
              },
              "displayName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "country": {
                "type": "string",
                "minLength": 2,
                "maxLength": 2,
                "pattern": "^[A-Z]{2}$",
                "description": "ISO 3166-1 alpha-2 country code"
              }
            },
            "required": [
              "kind",
              "displayName",
              "country"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "workspaceId",
          "entity"
        ],
        "additionalProperties": false
      },
      "CustomerCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "customerStatus": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "disabled",
              "erased"
            ]
          },
          "entityId": {
            "type": "string",
            "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale entity ID"
          },
          "entityStatus": {
            "type": "string",
            "enum": [
              "pending",
              "verified",
              "rejected",
              "disabled"
            ]
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "customerId",
          "customerStatus",
          "entityId",
          "entityStatus",
          "customerAccessId"
        ],
        "additionalProperties": false
      },
      "CustomerListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customerId": {
                  "type": "string",
                  "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Tenant-local customer ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "displayName": {
                  "type": "string"
                },
                "entityId": {
                  "type": "string",
                  "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale entity ID"
                },
                "externalReference": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "active",
                    "disabled",
                    "erased"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "customerId",
                "tenantId",
                "displayName"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "CustomerLoginInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "The Product to sign in to. One credential spans the company; each session is minted for exactly one of its Products."
          },
          "email": {
            "type": "string",
            "maxLength": 254,
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "password": {
            "type": "string",
            "minLength": 8,
            "maxLength": 128
          }
        },
        "required": [
          "workspaceId",
          "email",
          "password"
        ],
        "additionalProperties": false
      },
      "CustomerLoginOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "entityId": {
            "type": "string",
            "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale entity ID"
          },
          "email": {
            "type": "string",
            "maxLength": 254,
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "customerAccessStatus": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "suspended",
              "closed"
            ],
            "description": "The Product enrollment this session was minted against. Signing in is allowed while enrollment is pending so the customer can complete verification; the Product's own verbs stay refused until it is active."
          },
          "customerSessionId": {
            "type": "string",
            "pattern": "^csess_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale end-customer session ID"
          },
          "sessionToken": {
            "type": "string",
            "pattern": "^hyperscale_cust_[A-Za-z0-9_-]{32,64}$",
            "description": "One-time session token surfaced only in the first response; receipts and replays omit it"
          },
          "sessionExpiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "environment",
          "customerId",
          "entityId",
          "email",
          "customerAccessId",
          "customerAccessStatus",
          "customerSessionId",
          "sessionExpiresAt"
        ],
        "additionalProperties": false
      },
      "CustomerLogoutOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "customerSessionId": {
            "type": "string",
            "pattern": "^csess_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale end-customer session ID"
          },
          "status": {
            "type": "string",
            "const": "revoked"
          },
          "revokedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "customerSessionId",
          "status",
          "revokedAt"
        ],
        "additionalProperties": false
      },
      "CustomerRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "customerId": {
                "type": "string",
                "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Tenant-local customer ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "displayName": {
                "type": "string"
              },
              "entityId": {
                "type": "string",
                "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale entity ID"
              },
              "externalReference": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "active",
                  "disabled",
                  "erased"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "customerId",
              "tenantId",
              "displayName"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "CustomerSessionRevokeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "customerSessionId": {
            "type": "string",
            "pattern": "^csess_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale end-customer session ID"
          },
          "status": {
            "type": "string",
            "enum": [
              "revoked",
              "already_revoked"
            ]
          },
          "revokedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "customerSessionId",
          "status",
          "revokedAt"
        ],
        "additionalProperties": false
      },
      "CustomerSignupInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "The Product being signed up for. The company is resolved from it, so a shopper never names -- and never chooses -- the tenant they belong to."
          },
          "email": {
            "type": "string",
            "maxLength": 254,
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "password": {
            "type": "string",
            "minLength": 8,
            "maxLength": 128
          },
          "displayName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "country": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[A-Z]{2}$",
            "description": "ISO 3166-1 alpha-2 country code"
          },
          "termsAccepted": {
            "type": "boolean",
            "const": true,
            "description": "Affirmative click-wrap acceptance of the company's terms. Signup refuses without it."
          }
        },
        "required": [
          "workspaceId",
          "email",
          "password",
          "displayName",
          "termsAccepted"
        ],
        "additionalProperties": false
      },
      "CustomerSignupOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "entityId": {
            "type": "string",
            "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale entity ID"
          },
          "email": {
            "type": "string",
            "maxLength": 254,
            "format": "email",
            "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "customerAccessStatus": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "suspended",
              "closed"
            ],
            "description": "The Product enrollment this session was minted against. Signing in is allowed while enrollment is pending so the customer can complete verification; the Product's own verbs stay refused until it is active."
          },
          "customerSessionId": {
            "type": "string",
            "pattern": "^csess_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale end-customer session ID"
          },
          "sessionToken": {
            "type": "string",
            "pattern": "^hyperscale_cust_[A-Za-z0-9_-]{32,64}$",
            "description": "One-time session token surfaced only in the first response; receipts and replays omit it"
          },
          "sessionExpiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "displayName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "customerStatus": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "disabled",
              "erased"
            ]
          },
          "entityStatus": {
            "type": "string",
            "enum": [
              "pending",
              "verified",
              "rejected",
              "disabled"
            ]
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "environment",
          "customerId",
          "entityId",
          "email",
          "customerAccessId",
          "customerAccessStatus",
          "customerSessionId",
          "sessionExpiresAt",
          "displayName",
          "customerStatus",
          "entityStatus"
        ],
        "additionalProperties": false
      },
      "DepositListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "depositId": {
                  "type": "string",
                  "pattern": "^dep_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale deposit ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "accountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "financialAddressId": {
                  "type": "string",
                  "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale financial address ID"
                },
                "expectedPaymentId": {
                  "type": "string",
                  "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale expected payment ID"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "transferId": {
                  "type": "string",
                  "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale transfer ID"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "received",
                    "returned"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "depositId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "DepositRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "depositId": {
                "type": "string",
                "pattern": "^dep_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale deposit ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "financialAddressId": {
                "type": "string",
                "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale financial address ID"
              },
              "expectedPaymentId": {
                "type": "string",
                "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale expected payment ID"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "transferId": {
                "type": "string",
                "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale transfer ID"
              },
              "status": {
                "type": "string",
                "enum": [
                  "received",
                  "returned"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "depositId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "DeveloperLogListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "occurredAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "receiptId": {
                  "type": "string",
                  "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale receipt ID"
                },
                "requestId": {
                  "type": "string",
                  "minLength": 1
                },
                "sourceSurface": {
                  "type": "string",
                  "minLength": 1
                },
                "evidence": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "ledger",
                          "local",
                          "external"
                        ]
                      },
                      "reference": {
                        "type": "string",
                        "minLength": 1
                      },
                      "externalConfirmationId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "provider": {
                        "type": "string",
                        "minLength": 1
                      },
                      "providerReference": {
                        "type": "string",
                        "minLength": 1
                      },
                      "resourceKind": {
                        "type": "string",
                        "enum": [
                          "account",
                          "financial_address",
                          "api_key",
                          "audit",
                          "workspace_capability",
                          "charge",
                          "collection",
                          "consent",
                          "credit_balance",
                          "credit_grant",
                          "credit_ledger_entry",
                          "credit_note",
                          "credit_note_line",
                          "customer",
                          "beneficiary",
                          "deposit",
                          "entity",
                          "entity_kyc_profile",
                          "expected_payment",
                          "noun_instance",
                          "operation",
                          "payout",
                          "beneficiary_verification",
                          "workspace",
                          "customer_access",
                          "customer_session",
                          "external_confirmation",
                          "provider_cost_event",
                          "provider_webhook_event",
                          "webhook_endpoint",
                          "webhook_delivery",
                          "receipt",
                          "tenant",
                          "subject",
                          "subject_kind",
                          "statement_line",
                          "reconciliation_run",
                          "reconciliation_break",
                          "reporting_artifact",
                          "str_case",
                          "wedged_money_repair",
                          "reconciliation_break_repair",
                          "attribution_queue",
                          "user_session",
                          "internal_transfer",
                          "usage",
                          "billing_adjustment",
                          "meter_rate_discount",
                          "platform_alert",
                          "platform_rate_override",
                          "billing_period",
                          "billing_subscription",
                          "invoice",
                          "invoice_line",
                          "meter_period_snapshot",
                          "trust_review",
                          "trust_evidence",
                          "trust_requirement",
                          "trust_review_subject",
                          "support_ticket",
                          "support_ticket_message",
                          "support_booking",
                          "support_plan_selection",
                          "tenant_bank_connection"
                        ]
                      },
                      "resourceId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "operationId": {
                        "type": "string",
                        "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale operation ID"
                      },
                      "operation": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "name": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 120,
                            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                          },
                          "status": {
                            "type": "string",
                            "minLength": 1
                          }
                        },
                        "required": [
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "status": {
                        "type": "string",
                        "minLength": 1
                      },
                      "occurredAt": {
                        "type": "string",
                        "format": "date-time",
                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                      },
                      "proof": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      }
                    },
                    "required": [
                      "kind",
                      "reference"
                    ],
                    "additionalProperties": false
                  }
                },
                "errorEnvelope": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "minLength": 1
                    },
                    "message": {
                      "type": "string",
                      "minLength": 1
                    },
                    "status": {
                      "type": "integer",
                      "minimum": 100,
                      "maximum": 599
                    },
                    "details": {}
                  },
                  "required": [
                    "code",
                    "message",
                    "status"
                  ],
                  "additionalProperties": false
                },
                "timeline": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "minLength": 1
                      },
                      "reference": {
                        "type": "string",
                        "minLength": 1
                      },
                      "externalConfirmationId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "provider": {
                        "type": "string",
                        "minLength": 1
                      },
                      "providerReference": {
                        "type": "string",
                        "minLength": 1
                      },
                      "resourceKind": {
                        "anyOf": [
                          {
                            "type": "string",
                            "enum": [
                              "account",
                              "financial_address",
                              "api_key",
                              "audit",
                              "workspace_capability",
                              "charge",
                              "collection",
                              "consent",
                              "credit_balance",
                              "credit_grant",
                              "credit_ledger_entry",
                              "credit_note",
                              "credit_note_line",
                              "customer",
                              "beneficiary",
                              "deposit",
                              "entity",
                              "entity_kyc_profile",
                              "expected_payment",
                              "noun_instance",
                              "operation",
                              "payout",
                              "beneficiary_verification",
                              "workspace",
                              "customer_access",
                              "customer_session",
                              "external_confirmation",
                              "provider_cost_event",
                              "provider_webhook_event",
                              "webhook_endpoint",
                              "webhook_delivery",
                              "receipt",
                              "tenant",
                              "subject",
                              "subject_kind",
                              "statement_line",
                              "reconciliation_run",
                              "reconciliation_break",
                              "reporting_artifact",
                              "str_case",
                              "wedged_money_repair",
                              "reconciliation_break_repair",
                              "attribution_queue",
                              "user_session",
                              "internal_transfer",
                              "usage",
                              "billing_adjustment",
                              "meter_rate_discount",
                              "platform_alert",
                              "platform_rate_override",
                              "billing_period",
                              "billing_subscription",
                              "invoice",
                              "invoice_line",
                              "meter_period_snapshot",
                              "trust_review",
                              "trust_evidence",
                              "trust_requirement",
                              "trust_review_subject",
                              "support_ticket",
                              "support_ticket_message",
                              "support_booking",
                              "support_plan_selection",
                              "tenant_bank_connection",
                              "team",
                              "team_membership",
                              "user"
                            ]
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "resourceId": {
                        "anyOf": [
                          {
                            "type": "string",
                            "minLength": 1
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "operationId": {
                        "type": "string",
                        "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale operation ID"
                      },
                      "operation": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                            "description": "Hyperscale operation ID"
                          },
                          "name": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 120,
                            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                          },
                          "status": {
                            "type": "string",
                            "minLength": 1
                          }
                        },
                        "required": [
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "status": {
                        "type": "string",
                        "minLength": 1
                      },
                      "occurredAt": {
                        "type": "string",
                        "format": "date-time",
                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                      },
                      "proof": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      },
                      "usageRecordId": {
                        "type": "string",
                        "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale usage record ID"
                      },
                      "meter": {
                        "type": "string",
                        "enum": [
                          "account.active_month",
                          "account.created.count",
                          "financial_address.issued.count",
                          "financial_address.active_month",
                          "transfer.internal.count",
                          "transfer.internal.volume_sar",
                          "deposit.attributed.count",
                          "deposit.attributed.volume_sar",
                          "payout.external.count",
                          "payout.external.volume_sar",
                          "collection.pay_in.count",
                          "collection.pay_in.volume_sar",
                          "noun.event.count",
                          "noun.event.volume_sar",
                          "kyb.application.review",
                          "verification.kyc.basic.count",
                          "verification.kyc.standard.count",
                          "verification.kyc.investment.count",
                          "verification.kyb.count",
                          "operation.executed.count",
                          "api.read.count",
                          "billing.invoice.settlement",
                          "billing.plan.recurring_month",
                          "billing.product.activation"
                        ]
                      },
                      "quantity": {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                        "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                      },
                      "sourceEventId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "sourceOperationId": {
                        "type": "string",
                        "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale operation ID"
                      },
                      "workspaceId": {
                        "type": "string",
                        "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale workspace ID"
                      },
                      "operationName": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120,
                        "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                      },
                      "receiptId": {
                        "type": "string",
                        "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale receipt ID"
                      },
                      "type": {
                        "type": "string",
                        "minLength": 1
                      },
                      "finalizedAt": {
                        "anyOf": [
                          {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "auditEventId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "event": {
                        "type": "string",
                        "minLength": 1
                      },
                      "level": {
                        "type": "string",
                        "minLength": 1
                      },
                      "body": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      }
                    },
                    "required": [
                      "kind"
                    ],
                    "additionalProperties": {}
                  }
                },
                "usage": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "usageRecordId": {
                        "type": "string",
                        "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale usage record ID"
                      },
                      "meter": {
                        "type": "string",
                        "enum": [
                          "account.active_month",
                          "account.created.count",
                          "financial_address.issued.count",
                          "financial_address.active_month",
                          "transfer.internal.count",
                          "transfer.internal.volume_sar",
                          "deposit.attributed.count",
                          "deposit.attributed.volume_sar",
                          "payout.external.count",
                          "payout.external.volume_sar",
                          "collection.pay_in.count",
                          "collection.pay_in.volume_sar",
                          "noun.event.count",
                          "noun.event.volume_sar",
                          "kyb.application.review",
                          "verification.kyc.basic.count",
                          "verification.kyc.standard.count",
                          "verification.kyc.investment.count",
                          "verification.kyb.count",
                          "operation.executed.count",
                          "api.read.count",
                          "billing.invoice.settlement",
                          "billing.plan.recurring_month",
                          "billing.product.activation"
                        ]
                      },
                      "quantity": {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                        "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                      },
                      "sourceEventId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "sourceOperationId": {
                        "type": "string",
                        "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale operation ID"
                      },
                      "workspaceId": {
                        "type": "string",
                        "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                        "description": "Hyperscale workspace ID"
                      },
                      "occurredAt": {
                        "type": "string",
                        "format": "date-time",
                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                      }
                    },
                    "required": [
                      "usageRecordId",
                      "meter",
                      "quantity",
                      "occurredAt"
                    ],
                    "additionalProperties": false
                  }
                },
                "operationId": {
                  "type": "string",
                  "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale operation ID"
                },
                "operation": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "accepted",
                    "pending",
                    "succeeded",
                    "failed"
                  ]
                },
                "resource": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "account",
                        "financial_address",
                        "api_key",
                        "audit",
                        "workspace_capability",
                        "charge",
                        "collection",
                        "consent",
                        "credit_balance",
                        "credit_grant",
                        "credit_ledger_entry",
                        "credit_note",
                        "credit_note_line",
                        "customer",
                        "beneficiary",
                        "deposit",
                        "entity",
                        "entity_kyc_profile",
                        "expected_payment",
                        "noun_instance",
                        "operation",
                        "payout",
                        "beneficiary_verification",
                        "workspace",
                        "customer_access",
                        "customer_session",
                        "external_confirmation",
                        "provider_cost_event",
                        "provider_webhook_event",
                        "webhook_endpoint",
                        "webhook_delivery",
                        "receipt",
                        "tenant",
                        "subject",
                        "subject_kind",
                        "statement_line",
                        "reconciliation_run",
                        "reconciliation_break",
                        "reporting_artifact",
                        "str_case",
                        "wedged_money_repair",
                        "reconciliation_break_repair",
                        "attribution_queue",
                        "user_session",
                        "internal_transfer",
                        "usage",
                        "billing_adjustment",
                        "meter_rate_discount",
                        "platform_alert",
                        "platform_rate_override",
                        "billing_period",
                        "billing_subscription",
                        "invoice",
                        "invoice_line",
                        "meter_period_snapshot",
                        "trust_review",
                        "trust_evidence",
                        "trust_requirement",
                        "trust_review_subject",
                        "support_ticket",
                        "support_ticket_message",
                        "support_booking",
                        "support_plan_selection",
                        "tenant_bank_connection"
                      ]
                    },
                    "id": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "additionalProperties": false
                },
                "resourceKind": {
                  "type": "string",
                  "enum": [
                    "account",
                    "financial_address",
                    "api_key",
                    "audit",
                    "workspace_capability",
                    "charge",
                    "collection",
                    "consent",
                    "credit_balance",
                    "credit_grant",
                    "credit_ledger_entry",
                    "credit_note",
                    "credit_note_line",
                    "customer",
                    "beneficiary",
                    "deposit",
                    "entity",
                    "entity_kyc_profile",
                    "expected_payment",
                    "noun_instance",
                    "operation",
                    "payout",
                    "beneficiary_verification",
                    "workspace",
                    "customer_access",
                    "customer_session",
                    "external_confirmation",
                    "provider_cost_event",
                    "provider_webhook_event",
                    "webhook_endpoint",
                    "webhook_delivery",
                    "receipt",
                    "tenant",
                    "subject",
                    "subject_kind",
                    "statement_line",
                    "reconciliation_run",
                    "reconciliation_break",
                    "reporting_artifact",
                    "str_case",
                    "wedged_money_repair",
                    "reconciliation_break_repair",
                    "attribution_queue",
                    "user_session",
                    "internal_transfer",
                    "usage",
                    "billing_adjustment",
                    "meter_rate_discount",
                    "platform_alert",
                    "platform_rate_override",
                    "billing_period",
                    "billing_subscription",
                    "invoice",
                    "invoice_line",
                    "meter_period_snapshot",
                    "trust_review",
                    "trust_evidence",
                    "trust_requirement",
                    "trust_review_subject",
                    "support_ticket",
                    "support_ticket_message",
                    "support_booking",
                    "support_plan_selection",
                    "tenant_bank_connection"
                  ]
                },
                "resourceId": {
                  "type": "string",
                  "minLength": 1
                },
                "receipt": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale receipt ID"
                    },
                    "status": {
                      "type": "string",
                      "minLength": 1
                    },
                    "type": {
                      "type": "string",
                      "minLength": 1
                    },
                    "finalizedAt": {
                      "anyOf": [
                        {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "status",
                    "type",
                    "finalizedAt"
                  ],
                  "additionalProperties": false
                },
                "auditEvent": {
                  "type": "string",
                  "minLength": 1
                },
                "audit": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "auditEventId": {
                        "type": "string",
                        "minLength": 1
                      },
                      "event": {
                        "type": "string",
                        "minLength": 1
                      },
                      "level": {
                        "type": "string",
                        "minLength": 1
                      },
                      "resourceKind": {
                        "anyOf": [
                          {
                            "type": "string",
                            "enum": [
                              "account",
                              "financial_address",
                              "api_key",
                              "audit",
                              "workspace_capability",
                              "charge",
                              "collection",
                              "consent",
                              "credit_balance",
                              "credit_grant",
                              "credit_ledger_entry",
                              "credit_note",
                              "credit_note_line",
                              "customer",
                              "beneficiary",
                              "deposit",
                              "entity",
                              "entity_kyc_profile",
                              "expected_payment",
                              "noun_instance",
                              "operation",
                              "payout",
                              "beneficiary_verification",
                              "workspace",
                              "customer_access",
                              "customer_session",
                              "external_confirmation",
                              "provider_cost_event",
                              "provider_webhook_event",
                              "webhook_endpoint",
                              "webhook_delivery",
                              "receipt",
                              "tenant",
                              "subject",
                              "subject_kind",
                              "statement_line",
                              "reconciliation_run",
                              "reconciliation_break",
                              "reporting_artifact",
                              "str_case",
                              "wedged_money_repair",
                              "reconciliation_break_repair",
                              "attribution_queue",
                              "user_session",
                              "internal_transfer",
                              "usage",
                              "billing_adjustment",
                              "meter_rate_discount",
                              "platform_alert",
                              "platform_rate_override",
                              "billing_period",
                              "billing_subscription",
                              "invoice",
                              "invoice_line",
                              "meter_period_snapshot",
                              "trust_review",
                              "trust_evidence",
                              "trust_requirement",
                              "trust_review_subject",
                              "support_ticket",
                              "support_ticket_message",
                              "support_booking",
                              "support_plan_selection",
                              "tenant_bank_connection",
                              "team",
                              "team_membership",
                              "user"
                            ]
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "resourceId": {
                        "anyOf": [
                          {
                            "type": "string",
                            "minLength": 1
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "body": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {}
                      },
                      "occurredAt": {
                        "type": "string",
                        "format": "date-time",
                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                      }
                    },
                    "required": [
                      "auditEventId",
                      "event",
                      "occurredAt"
                    ],
                    "additionalProperties": false
                  }
                },
                "principalId": {
                  "type": "string",
                  "pattern": "^prn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale principal ID"
                },
                "finalizedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "occurredAt",
                "evidence",
                "timeline",
                "usage",
                "operationId",
                "operation",
                "status",
                "audit"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "DeveloperLogRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "log": {
            "type": "object",
            "properties": {
              "occurredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "receiptId": {
                "type": "string",
                "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale receipt ID"
              },
              "requestId": {
                "type": "string",
                "minLength": 1
              },
              "sourceSurface": {
                "type": "string",
                "minLength": 1
              },
              "evidence": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "ledger",
                        "local",
                        "external"
                      ]
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1
                    },
                    "externalConfirmationId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "provider": {
                      "type": "string",
                      "minLength": 1
                    },
                    "providerReference": {
                      "type": "string",
                      "minLength": 1
                    },
                    "resourceKind": {
                      "type": "string",
                      "enum": [
                        "account",
                        "financial_address",
                        "api_key",
                        "audit",
                        "workspace_capability",
                        "charge",
                        "collection",
                        "consent",
                        "credit_balance",
                        "credit_grant",
                        "credit_ledger_entry",
                        "credit_note",
                        "credit_note_line",
                        "customer",
                        "beneficiary",
                        "deposit",
                        "entity",
                        "entity_kyc_profile",
                        "expected_payment",
                        "noun_instance",
                        "operation",
                        "payout",
                        "beneficiary_verification",
                        "workspace",
                        "customer_access",
                        "customer_session",
                        "external_confirmation",
                        "provider_cost_event",
                        "provider_webhook_event",
                        "webhook_endpoint",
                        "webhook_delivery",
                        "receipt",
                        "tenant",
                        "subject",
                        "subject_kind",
                        "statement_line",
                        "reconciliation_run",
                        "reconciliation_break",
                        "reporting_artifact",
                        "str_case",
                        "wedged_money_repair",
                        "reconciliation_break_repair",
                        "attribution_queue",
                        "user_session",
                        "internal_transfer",
                        "usage",
                        "billing_adjustment",
                        "meter_rate_discount",
                        "platform_alert",
                        "platform_rate_override",
                        "billing_period",
                        "billing_subscription",
                        "invoice",
                        "invoice_line",
                        "meter_period_snapshot",
                        "trust_review",
                        "trust_evidence",
                        "trust_requirement",
                        "trust_review_subject",
                        "support_ticket",
                        "support_ticket_message",
                        "support_booking",
                        "support_plan_selection",
                        "tenant_bank_connection"
                      ]
                    },
                    "resourceId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "operationId": {
                      "type": "string",
                      "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale operation ID"
                    },
                    "operation": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                          "description": "Hyperscale operation ID"
                        },
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 120,
                          "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                        },
                        "status": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "status": {
                      "type": "string",
                      "minLength": 1
                    },
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "proof": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "kind",
                    "reference"
                  ],
                  "additionalProperties": false
                }
              },
              "errorEnvelope": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "minLength": 1
                  },
                  "message": {
                    "type": "string",
                    "minLength": 1
                  },
                  "status": {
                    "type": "integer",
                    "minimum": 100,
                    "maximum": 599
                  },
                  "details": {}
                },
                "required": [
                  "code",
                  "message",
                  "status"
                ],
                "additionalProperties": false
              },
              "timeline": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "minLength": 1
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1
                    },
                    "externalConfirmationId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "provider": {
                      "type": "string",
                      "minLength": 1
                    },
                    "providerReference": {
                      "type": "string",
                      "minLength": 1
                    },
                    "resourceKind": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "account",
                            "financial_address",
                            "api_key",
                            "audit",
                            "workspace_capability",
                            "charge",
                            "collection",
                            "consent",
                            "credit_balance",
                            "credit_grant",
                            "credit_ledger_entry",
                            "credit_note",
                            "credit_note_line",
                            "customer",
                            "beneficiary",
                            "deposit",
                            "entity",
                            "entity_kyc_profile",
                            "expected_payment",
                            "noun_instance",
                            "operation",
                            "payout",
                            "beneficiary_verification",
                            "workspace",
                            "customer_access",
                            "customer_session",
                            "external_confirmation",
                            "provider_cost_event",
                            "provider_webhook_event",
                            "webhook_endpoint",
                            "webhook_delivery",
                            "receipt",
                            "tenant",
                            "subject",
                            "subject_kind",
                            "statement_line",
                            "reconciliation_run",
                            "reconciliation_break",
                            "reporting_artifact",
                            "str_case",
                            "wedged_money_repair",
                            "reconciliation_break_repair",
                            "attribution_queue",
                            "user_session",
                            "internal_transfer",
                            "usage",
                            "billing_adjustment",
                            "meter_rate_discount",
                            "platform_alert",
                            "platform_rate_override",
                            "billing_period",
                            "billing_subscription",
                            "invoice",
                            "invoice_line",
                            "meter_period_snapshot",
                            "trust_review",
                            "trust_evidence",
                            "trust_requirement",
                            "trust_review_subject",
                            "support_ticket",
                            "support_ticket_message",
                            "support_booking",
                            "support_plan_selection",
                            "tenant_bank_connection",
                            "team",
                            "team_membership",
                            "user"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "resourceId": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "operationId": {
                      "type": "string",
                      "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale operation ID"
                    },
                    "operation": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                          "description": "Hyperscale operation ID"
                        },
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 120,
                          "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                        },
                        "status": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "status": {
                      "type": "string",
                      "minLength": 1
                    },
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "proof": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    },
                    "usageRecordId": {
                      "type": "string",
                      "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale usage record ID"
                    },
                    "meter": {
                      "type": "string",
                      "enum": [
                        "account.active_month",
                        "account.created.count",
                        "financial_address.issued.count",
                        "financial_address.active_month",
                        "transfer.internal.count",
                        "transfer.internal.volume_sar",
                        "deposit.attributed.count",
                        "deposit.attributed.volume_sar",
                        "payout.external.count",
                        "payout.external.volume_sar",
                        "collection.pay_in.count",
                        "collection.pay_in.volume_sar",
                        "noun.event.count",
                        "noun.event.volume_sar",
                        "kyb.application.review",
                        "verification.kyc.basic.count",
                        "verification.kyc.standard.count",
                        "verification.kyc.investment.count",
                        "verification.kyb.count",
                        "operation.executed.count",
                        "api.read.count",
                        "billing.invoice.settlement",
                        "billing.plan.recurring_month",
                        "billing.product.activation"
                      ]
                    },
                    "quantity": {
                      "type": "string",
                      "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                      "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                    },
                    "sourceEventId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "sourceOperationId": {
                      "type": "string",
                      "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale operation ID"
                    },
                    "workspaceId": {
                      "type": "string",
                      "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale workspace ID"
                    },
                    "operationName": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                    },
                    "receiptId": {
                      "type": "string",
                      "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale receipt ID"
                    },
                    "type": {
                      "type": "string",
                      "minLength": 1
                    },
                    "finalizedAt": {
                      "anyOf": [
                        {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "auditEventId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "event": {
                      "type": "string",
                      "minLength": 1
                    },
                    "level": {
                      "type": "string",
                      "minLength": 1
                    },
                    "body": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "additionalProperties": {}
                }
              },
              "usage": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "usageRecordId": {
                      "type": "string",
                      "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale usage record ID"
                    },
                    "meter": {
                      "type": "string",
                      "enum": [
                        "account.active_month",
                        "account.created.count",
                        "financial_address.issued.count",
                        "financial_address.active_month",
                        "transfer.internal.count",
                        "transfer.internal.volume_sar",
                        "deposit.attributed.count",
                        "deposit.attributed.volume_sar",
                        "payout.external.count",
                        "payout.external.volume_sar",
                        "collection.pay_in.count",
                        "collection.pay_in.volume_sar",
                        "noun.event.count",
                        "noun.event.volume_sar",
                        "kyb.application.review",
                        "verification.kyc.basic.count",
                        "verification.kyc.standard.count",
                        "verification.kyc.investment.count",
                        "verification.kyb.count",
                        "operation.executed.count",
                        "api.read.count",
                        "billing.invoice.settlement",
                        "billing.plan.recurring_month",
                        "billing.product.activation"
                      ]
                    },
                    "quantity": {
                      "type": "string",
                      "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$",
                      "description": "Non-negative usage quantity with up to six decimal places (integer part at most 18 digits)"
                    },
                    "sourceEventId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "sourceOperationId": {
                      "type": "string",
                      "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale operation ID"
                    },
                    "workspaceId": {
                      "type": "string",
                      "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale workspace ID"
                    },
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "usageRecordId",
                    "meter",
                    "quantity",
                    "occurredAt"
                  ],
                  "additionalProperties": false
                }
              },
              "operationId": {
                "type": "string",
                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale operation ID"
              },
              "operation": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120,
                "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
              },
              "status": {
                "type": "string",
                "enum": [
                  "accepted",
                  "pending",
                  "succeeded",
                  "failed"
                ]
              },
              "resource": {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "account",
                      "financial_address",
                      "api_key",
                      "audit",
                      "workspace_capability",
                      "charge",
                      "collection",
                      "consent",
                      "credit_balance",
                      "credit_grant",
                      "credit_ledger_entry",
                      "credit_note",
                      "credit_note_line",
                      "customer",
                      "beneficiary",
                      "deposit",
                      "entity",
                      "entity_kyc_profile",
                      "expected_payment",
                      "noun_instance",
                      "operation",
                      "payout",
                      "beneficiary_verification",
                      "workspace",
                      "customer_access",
                      "customer_session",
                      "external_confirmation",
                      "provider_cost_event",
                      "provider_webhook_event",
                      "webhook_endpoint",
                      "webhook_delivery",
                      "receipt",
                      "tenant",
                      "subject",
                      "subject_kind",
                      "statement_line",
                      "reconciliation_run",
                      "reconciliation_break",
                      "reporting_artifact",
                      "str_case",
                      "wedged_money_repair",
                      "reconciliation_break_repair",
                      "attribution_queue",
                      "user_session",
                      "internal_transfer",
                      "usage",
                      "billing_adjustment",
                      "meter_rate_discount",
                      "platform_alert",
                      "platform_rate_override",
                      "billing_period",
                      "billing_subscription",
                      "invoice",
                      "invoice_line",
                      "meter_period_snapshot",
                      "trust_review",
                      "trust_evidence",
                      "trust_requirement",
                      "trust_review_subject",
                      "support_ticket",
                      "support_ticket_message",
                      "support_booking",
                      "support_plan_selection",
                      "tenant_bank_connection"
                    ]
                  },
                  "id": {
                    "type": "string",
                    "minLength": 1
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              "resourceKind": {
                "type": "string",
                "enum": [
                  "account",
                  "financial_address",
                  "api_key",
                  "audit",
                  "workspace_capability",
                  "charge",
                  "collection",
                  "consent",
                  "credit_balance",
                  "credit_grant",
                  "credit_ledger_entry",
                  "credit_note",
                  "credit_note_line",
                  "customer",
                  "beneficiary",
                  "deposit",
                  "entity",
                  "entity_kyc_profile",
                  "expected_payment",
                  "noun_instance",
                  "operation",
                  "payout",
                  "beneficiary_verification",
                  "workspace",
                  "customer_access",
                  "customer_session",
                  "external_confirmation",
                  "provider_cost_event",
                  "provider_webhook_event",
                  "webhook_endpoint",
                  "webhook_delivery",
                  "receipt",
                  "tenant",
                  "subject",
                  "subject_kind",
                  "statement_line",
                  "reconciliation_run",
                  "reconciliation_break",
                  "reporting_artifact",
                  "str_case",
                  "wedged_money_repair",
                  "reconciliation_break_repair",
                  "attribution_queue",
                  "user_session",
                  "internal_transfer",
                  "usage",
                  "billing_adjustment",
                  "meter_rate_discount",
                  "platform_alert",
                  "platform_rate_override",
                  "billing_period",
                  "billing_subscription",
                  "invoice",
                  "invoice_line",
                  "meter_period_snapshot",
                  "trust_review",
                  "trust_evidence",
                  "trust_requirement",
                  "trust_review_subject",
                  "support_ticket",
                  "support_ticket_message",
                  "support_booking",
                  "support_plan_selection",
                  "tenant_bank_connection"
                ]
              },
              "resourceId": {
                "type": "string",
                "minLength": 1
              },
              "receipt": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                    "description": "Hyperscale receipt ID"
                  },
                  "status": {
                    "type": "string",
                    "minLength": 1
                  },
                  "type": {
                    "type": "string",
                    "minLength": 1
                  },
                  "finalizedAt": {
                    "anyOf": [
                      {
                        "type": "string",
                        "format": "date-time",
                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "id",
                  "status",
                  "type",
                  "finalizedAt"
                ],
                "additionalProperties": false
              },
              "auditEvent": {
                "type": "string",
                "minLength": 1
              },
              "audit": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "auditEventId": {
                      "type": "string",
                      "minLength": 1
                    },
                    "event": {
                      "type": "string",
                      "minLength": 1
                    },
                    "level": {
                      "type": "string",
                      "minLength": 1
                    },
                    "resourceKind": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "account",
                            "financial_address",
                            "api_key",
                            "audit",
                            "workspace_capability",
                            "charge",
                            "collection",
                            "consent",
                            "credit_balance",
                            "credit_grant",
                            "credit_ledger_entry",
                            "credit_note",
                            "credit_note_line",
                            "customer",
                            "beneficiary",
                            "deposit",
                            "entity",
                            "entity_kyc_profile",
                            "expected_payment",
                            "noun_instance",
                            "operation",
                            "payout",
                            "beneficiary_verification",
                            "workspace",
                            "customer_access",
                            "customer_session",
                            "external_confirmation",
                            "provider_cost_event",
                            "provider_webhook_event",
                            "webhook_endpoint",
                            "webhook_delivery",
                            "receipt",
                            "tenant",
                            "subject",
                            "subject_kind",
                            "statement_line",
                            "reconciliation_run",
                            "reconciliation_break",
                            "reporting_artifact",
                            "str_case",
                            "wedged_money_repair",
                            "reconciliation_break_repair",
                            "attribution_queue",
                            "user_session",
                            "internal_transfer",
                            "usage",
                            "billing_adjustment",
                            "meter_rate_discount",
                            "platform_alert",
                            "platform_rate_override",
                            "billing_period",
                            "billing_subscription",
                            "invoice",
                            "invoice_line",
                            "meter_period_snapshot",
                            "trust_review",
                            "trust_evidence",
                            "trust_requirement",
                            "trust_review_subject",
                            "support_ticket",
                            "support_ticket_message",
                            "support_booking",
                            "support_plan_selection",
                            "tenant_bank_connection",
                            "team",
                            "team_membership",
                            "user"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "resourceId": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "body": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    },
                    "occurredAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "auditEventId",
                    "event",
                    "occurredAt"
                  ],
                  "additionalProperties": false
                }
              },
              "principalId": {
                "type": "string",
                "pattern": "^prn_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale principal ID"
              },
              "finalizedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "occurredAt",
              "evidence",
              "timeline",
              "usage",
              "operationId",
              "operation",
              "status",
              "audit"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "tenantId",
          "log"
        ],
        "additionalProperties": false
      },
      "EscrowOrderCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderCollectPenaltyOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "penalty_collected"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "buyerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing whose subject and availability this escrow protects"
          },
          "fundBy": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle, merchandise. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "buyerAccountId",
          "listingId",
          "subject"
        ],
        "additionalProperties": false
      },
      "EscrowOrderCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderDisputeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "disputed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderFundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "funded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "escrowOrderId": {
                  "type": "string",
                  "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Escrow order instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "escrow_order"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "funded",
                    "disputed",
                    "refund_quoted",
                    "released",
                    "refunded",
                    "penalty_collected",
                    "canceled",
                    "expired"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "buyerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "sellerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "listingId": {
                      "type": "string",
                      "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Listing whose subject and availability this escrow protects"
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "fundBy": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "buyerAccountId",
                    "sellerAccountId",
                    "listingId",
                    "amount",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "escrowAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "releaseTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "penaltyTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindRefund": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindPenalty": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "escrowOrderId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "EscrowOrderQuoteOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "refund_quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderRefundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "refunded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderReleaseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "released"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderResumeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "const": "funded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "funded",
              "disputed",
              "refund_quoted",
              "released",
              "refunded",
              "penalty_collected",
              "canceled",
              "expired"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EscrowOrderUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fundBy": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "EscrowOrderUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "escrow_order"
          },
          "status": {
            "type": "string",
            "enum": [
              "created"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject and availability this escrow protects"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "fundBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "escrowOrderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "EventListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale audit event ID"
                },
                "object": {
                  "type": "string",
                  "const": "event"
                },
                "apiVersion": {
                  "type": "string",
                  "const": "2026-06-04"
                },
                "environment": {
                  "type": "string",
                  "enum": [
                    "sandbox",
                    "live"
                  ]
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "event": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "operationId": {
                  "anyOf": [
                    {
                      "type": "string",
                      "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale operation ID"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "relatedObject": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "id",
                        "type"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "data": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "object"
                  ],
                  "additionalProperties": false
                },
                "outbox": {
                  "type": "object",
                  "properties": {
                    "payloadDigest": {
                      "type": "string",
                      "pattern": "^sha256:[a-f0-9]{64}$"
                    }
                  },
                  "required": [
                    "payloadDigest"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "object",
                "apiVersion",
                "environment",
                "tenantId",
                "event",
                "createdAt",
                "operationId",
                "relatedObject",
                "data"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "EventRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale audit event ID"
          },
          "object": {
            "type": "string",
            "const": "event"
          },
          "apiVersion": {
            "type": "string",
            "const": "2026-06-04"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "event": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120,
            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
            "description": "Hyperscale audit event type emitted from an operation policy"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "operationId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale operation ID"
              },
              {
                "type": "null"
              }
            ]
          },
          "relatedObject": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "type"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "object": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              }
            },
            "required": [
              "object"
            ],
            "additionalProperties": false
          },
          "outbox": {
            "type": "object",
            "properties": {
              "payloadDigest": {
                "type": "string",
                "pattern": "^sha256:[a-f0-9]{64}$"
              }
            },
            "required": [
              "payloadDigest"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "object",
          "apiVersion",
          "environment",
          "tenantId",
          "event",
          "createdAt",
          "operationId",
          "relatedObject",
          "data"
        ],
        "additionalProperties": false
      },
      "ExpectedPaymentCancelBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "ExpectedPaymentCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "expectedPaymentId": {
            "type": "string",
            "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale expected payment ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "expectedPaymentId",
          "tenantId",
          "status",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ExpectedPaymentCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "expectedPaymentId": {
            "type": "string",
            "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale expected payment ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "financialAddressId": {
            "type": "string",
            "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale financial address ID"
          },
          "amountMin": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amountMax": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "windowStart": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "windowEnd": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reference": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "metadata": {
            "$ref": "#/components/schemas/ExpectedPaymentCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "workspaceId",
          "accountId",
          "financialAddressId",
          "amountMin",
          "amountMax",
          "currency",
          "windowStart",
          "windowEnd"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/ExpectedPaymentCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ExpectedPaymentCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ExpectedPaymentCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/ExpectedPaymentCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "ExpectedPaymentCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "expectedPaymentId": {
            "type": "string",
            "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale expected payment ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "financialAddressId": {
            "type": "string",
            "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale financial address ID"
          },
          "amountMin": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amountMax": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amountReceived": {
            "type": "string",
            "const": "0"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "windowStart": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "windowEnd": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reference": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "status": {
            "type": "string",
            "const": "expected"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "metadata": {
            "$ref": "#/components/schemas/ExpectedPaymentCreateOutput/$defs/Metadata"
          }
        },
        "required": [
          "expectedPaymentId",
          "tenantId",
          "workspaceId",
          "accountId",
          "financialAddressId",
          "amountMin",
          "amountMax",
          "amountReceived",
          "currency",
          "windowStart",
          "windowEnd",
          "status",
          "createdAt",
          "metadata"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/ExpectedPaymentCreateOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ExpectedPaymentCreateOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ExpectedPaymentCreateOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/ExpectedPaymentCreateOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "ExpectedPaymentListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "expectedPaymentId": {
                  "type": "string",
                  "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale expected payment ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "accountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "financialAddressId": {
                  "type": "string",
                  "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale financial address ID"
                },
                "amountMin": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "amountMax": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "amountReceived": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "windowStart": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "windowEnd": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "reference": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "expected",
                    "partially_received",
                    "received",
                    "overdue",
                    "canceled"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "expectedPaymentId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ExpectedPaymentRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "expectedPaymentId": {
                "type": "string",
                "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale expected payment ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "financialAddressId": {
                "type": "string",
                "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale financial address ID"
              },
              "amountMin": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "amountMax": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "amountReceived": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "windowStart": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "windowEnd": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "reference": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "expected",
                  "partially_received",
                  "received",
                  "overdue",
                  "canceled"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "expectedPaymentId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "ExposureArrangementApproveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "exposureArrangementId": {
            "type": "string",
            "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Exposure arrangement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "exposure_arrangement"
          },
          "status": {
            "type": "string",
            "const": "approved"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerEntityId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "description": "Evidence subject the borrower's provider checks are bound to"
              },
              "approvedAmountsCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "outstandingCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "borrowerEntityId",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "exposureArrangementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ExposureArrangementCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "exposureArrangementId": {
            "type": "string",
            "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Exposure arrangement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "exposure_arrangement"
          },
          "status": {
            "type": "string",
            "const": "closed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerEntityId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "description": "Evidence subject the borrower's provider checks are bound to"
              },
              "approvedAmountsCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "outstandingCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "borrowerEntityId",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "exposureArrangementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ExposureArrangementListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "exposureArrangementId": {
                  "type": "string",
                  "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Exposure arrangement instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "exposure_arrangement"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending_approval",
                    "approved",
                    "rejected",
                    "closed"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "borrowerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "borrowerEntityId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80,
                      "description": "Evidence subject the borrower's provider checks are bound to"
                    },
                    "approvedAmountsCapAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "outstandingCapAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "borrowerAccountId",
                    "borrowerEntityId",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "exposureArrangementId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ExposureArrangementRejectOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "exposureArrangementId": {
            "type": "string",
            "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Exposure arrangement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "exposure_arrangement"
          },
          "status": {
            "type": "string",
            "const": "rejected"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerEntityId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "description": "Evidence subject the borrower's provider checks are bound to"
              },
              "approvedAmountsCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "outstandingCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "borrowerEntityId",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "exposureArrangementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ExposureArrangementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "exposureArrangementId": {
            "type": "string",
            "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Exposure arrangement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "exposure_arrangement"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending_approval",
              "approved",
              "rejected",
              "closed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerEntityId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "description": "Evidence subject the borrower's provider checks are bound to"
              },
              "approvedAmountsCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "outstandingCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "borrowerEntityId",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "exposureArrangementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ExposureArrangementUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "ExposureArrangementUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "exposureArrangementId": {
            "type": "string",
            "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Exposure arrangement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "exposure_arrangement"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending_approval",
              "approved"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerEntityId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "description": "Evidence subject the borrower's provider checks are bound to"
              },
              "approvedAmountsCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "outstandingCapAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "borrowerEntityId",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "exposureArrangementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ExtensionListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "enum": [
                    "cards",
                    "collections",
                    "conditional_custody",
                    "crowdfunding",
                    "insurance",
                    "lending",
                    "marketplace",
                    "payouts",
                    "savings_circles",
                    "travel",
                    "vehicle_trading",
                    "wallets"
                  ]
                },
                "title": {
                  "type": "string",
                  "minLength": 1
                },
                "summary": {
                  "type": "string",
                  "minLength": 1
                },
                "nounIds": {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "card",
                      "card_authorization",
                      "card_dispute",
                      "card_transaction",
                      "cardholder",
                      "circle_membership",
                      "claim",
                      "collections_case",
                      "contact_attempt",
                      "credit_agreement",
                      "escrow_order",
                      "exposure_arrangement",
                      "flight_booking",
                      "funding_commitment",
                      "funding_round",
                      "held_settlement",
                      "hotel_stay",
                      "installment",
                      "lender_distribution",
                      "listing",
                      "motor_policy",
                      "order",
                      "payout_run",
                      "policy",
                      "sale_settlement",
                      "trade_settlement",
                      "travel_package",
                      "savings_circle",
                      "vehicle_escrow",
                      "vehicle_listing",
                      "wallet",
                      "wallet_spend"
                    ]
                  }
                },
                "attachments": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "card",
                      "card_authorization",
                      "card_dispute",
                      "card_transaction",
                      "cardholder",
                      "circle_membership",
                      "claim",
                      "collections_case",
                      "contact_attempt",
                      "credit_agreement",
                      "escrow_order",
                      "exposure_arrangement",
                      "flight_booking",
                      "funding_commitment",
                      "funding_round",
                      "held_settlement",
                      "hotel_stay",
                      "installment",
                      "lender_distribution",
                      "listing",
                      "motor_policy",
                      "order",
                      "payout_run",
                      "policy",
                      "sale_settlement",
                      "trade_settlement",
                      "travel_package",
                      "savings_circle",
                      "vehicle_escrow",
                      "vehicle_listing",
                      "wallet",
                      "wallet_spend"
                    ]
                  },
                  "description": "Business nouns the target Product must already contain (or add in the same recomposition) for this extension's wiring to resolve; derived from the noun reference graph, empty for a self-contained extension"
                }
              },
              "required": [
                "id",
                "title",
                "summary",
                "nounIds",
                "attachments"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ExternalWebhookEventEnvelope": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale audit event ID"
          },
          "object": {
            "type": "string",
            "const": "event"
          },
          "apiVersion": {
            "type": "string",
            "const": "2026-06-04"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "event": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120,
            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
            "description": "Hyperscale audit event type emitted from an operation policy"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "operationId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale operation ID"
              },
              {
                "type": "null"
              }
            ]
          },
          "relatedObject": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "type"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "object": {
                "type": "object",
                "properties": {
                  "accountId": {},
                  "amount": {},
                  "currency": {},
                  "expiredAt": {},
                  "expiresAt": {},
                  "externalConfirmations": {},
                  "metadata": {},
                  "operationName": {},
                  "postedAmount": {},
                  "receivedAt": {},
                  "remainingReservedAmount": {},
                  "sourceSurface": {},
                  "status": {}
                },
                "additionalProperties": false
              }
            },
            "required": [
              "object"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "object",
          "apiVersion",
          "environment",
          "tenantId",
          "event",
          "createdAt",
          "operationId",
          "relatedObject",
          "data"
        ],
        "additionalProperties": false
      },
      "FinancialAddressCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "financialAddressId": {
            "type": "string",
            "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale financial address ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "purpose": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "metadata": {
            "$ref": "#/components/schemas/FinancialAddressCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "accountId"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/FinancialAddressCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FinancialAddressCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/FinancialAddressCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/FinancialAddressCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "FinancialAddressCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "financialAddressId": {
            "type": "string",
            "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale financial address ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "status": {
            "type": "string",
            "const": "requested"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "metadata": {
            "$ref": "#/components/schemas/FinancialAddressCreateOutput/$defs/Metadata"
          }
        },
        "required": [
          "financialAddressId",
          "tenantId",
          "accountId",
          "status",
          "createdAt",
          "metadata"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/FinancialAddressCreateOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/FinancialAddressCreateOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/FinancialAddressCreateOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/FinancialAddressCreateOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "FinancialAddressDisableBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "FinancialAddressDisableOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "financialAddressId": {
            "type": "string",
            "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale financial address ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "accountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "status": {
            "type": "string",
            "const": "disabled"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "financialAddressId",
          "tenantId",
          "accountId",
          "status",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FinancialAddressListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "financialAddressId": {
                  "type": "string",
                  "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale financial address ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "address": {
                  "type": "string"
                },
                "accountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "purpose": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "requested",
                    "active",
                    "disabled"
                  ]
                },
                "activeAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "addressClass": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "financialAddressId",
                "tenantId",
                "address"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "FinancialAddressRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "financialAddressId": {
                "type": "string",
                "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale financial address ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "address": {
                "type": "string"
              },
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "purpose": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "requested",
                  "active",
                  "disabled"
                ]
              },
              "activeAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "addressClass": {
                "type": "string"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "financialAddressId",
              "tenantId",
              "address"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "FlightBookingAmendCollectBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fareDifference": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amendmentNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "fareDifference",
          "amendmentNote"
        ],
        "additionalProperties": false
      },
      "FlightBookingAmendCollectOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingAmendFeeBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "amendmentFee": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amendmentNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "amendmentFee",
          "amendmentNote"
        ],
        "additionalProperties": false
      },
      "FlightBookingAmendFeeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingAmendRefundBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fareDifference": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amendmentNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "fareDifference",
          "amendmentNote"
        ],
        "additionalProperties": false
      },
      "FlightBookingAmendRefundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingCancelConfirmOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingCancelQuoteOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "cancel_quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingCollectPenaltyOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "penalty_collected"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingConfirmOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "travelerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "operatorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "fareAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "holdExpiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "departsAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "bookingNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package this booking is a leg of"
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: flight_itinerary. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "travelerAccountId",
          "operatorAccountId",
          "fareAmount",
          "currency",
          "holdExpiresAt",
          "departsAt",
          "subject"
        ],
        "additionalProperties": false
      },
      "FlightBookingCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "held"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "flightBookingId": {
                  "type": "string",
                  "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Flight booking instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "flight_booking"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "held",
                    "released",
                    "confirmed",
                    "cancel_quoted",
                    "completed",
                    "canceled",
                    "penalty_collected",
                    "package_canceled",
                    "expired"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "travelerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "operatorAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "fareAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "holdExpiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "departsAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "bookingNote": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "travelPackageId": {
                      "type": "string",
                      "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Travel package this booking is a leg of"
                    }
                  },
                  "required": [
                    "travelerAccountId",
                    "operatorAccountId",
                    "fareAmount",
                    "currency",
                    "holdExpiresAt",
                    "departsAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "fareReserveAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fareTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "amendCollectTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "amendRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "amendFeeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "penaltyTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "packageRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "farePayoutTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindRefund": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindPenalty": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "flightBookingId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "FlightBookingReleaseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "const": "released"
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "enum": [
              "held",
              "released",
              "confirmed",
              "cancel_quoted",
              "completed",
              "canceled",
              "penalty_collected",
              "package_canceled",
              "expired"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FlightBookingUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "departsAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "bookingNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "FlightBookingUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "flightBookingId": {
            "type": "string",
            "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Flight booking instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "flight_booking"
          },
          "status": {
            "type": "string",
            "enum": [
              "held",
              "confirmed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "travelerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "operatorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fareAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "departsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "bookingNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this booking is a leg of"
              }
            },
            "required": [
              "travelerAccountId",
              "operatorAccountId",
              "fareAmount",
              "currency",
              "holdExpiresAt",
              "departsAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "fareReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fareTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "farePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "flightBookingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FundingCommitmentCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "fundingRoundId": {
            "type": "string",
            "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding round this pledge counts toward"
          },
          "investorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "committedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "workspaceId",
          "fundingRoundId",
          "investorAccountId",
          "amount",
          "committedAt"
        ],
        "additionalProperties": false
      },
      "FundingCommitmentCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fundingCommitmentId": {
            "type": "string",
            "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding commitment instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "funding_commitment"
          },
          "status": {
            "type": "string",
            "const": "committed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round this pledge counts toward"
              },
              "investorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "escrowAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "committedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "fundingRoundId",
              "investorAccountId",
              "borrowerAccountId",
              "escrowAccountId",
              "currency",
              "amount",
              "committedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "pledgeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "collectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "fundingCommitmentId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FundingCommitmentListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fundingCommitmentId": {
                  "type": "string",
                  "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Funding commitment instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "funding_commitment"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "committed",
                    "collected",
                    "refunded"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "fundingRoundId": {
                      "type": "string",
                      "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Funding round this pledge counts toward"
                    },
                    "investorAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "borrowerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "escrowAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "committedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "fundingRoundId",
                    "investorAccountId",
                    "borrowerAccountId",
                    "escrowAccountId",
                    "currency",
                    "amount",
                    "committedAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "pledgeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "collectTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "fundingCommitmentId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "FundingCommitmentRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fundingCommitmentId": {
            "type": "string",
            "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding commitment instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "funding_commitment"
          },
          "status": {
            "type": "string",
            "enum": [
              "committed",
              "collected",
              "refunded"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round this pledge counts toward"
              },
              "investorAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "escrowAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "committedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "fundingRoundId",
              "investorAccountId",
              "borrowerAccountId",
              "escrowAccountId",
              "currency",
              "amount",
              "committedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "pledgeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "collectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "fundingCommitmentId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FundingRoundCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fundingRoundId": {
            "type": "string",
            "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding round instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "funding_round"
          },
          "status": {
            "type": "string",
            "const": "settled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "targetAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "closeBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "targetAmount",
              "currency",
              "closeBy"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "fundingRoundId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FundingRoundCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "borrowerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "targetAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "closeBy": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "borrowerAccountId",
          "targetAmount",
          "currency",
          "closeBy"
        ],
        "additionalProperties": false
      },
      "FundingRoundCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fundingRoundId": {
            "type": "string",
            "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding round instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "funding_round"
          },
          "status": {
            "type": "string",
            "const": "open"
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "targetAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "closeBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "targetAmount",
              "currency",
              "closeBy"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "fundingRoundId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "FundingRoundListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fundingRoundId": {
                  "type": "string",
                  "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Funding round instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "funding_round"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "open",
                    "active",
                    "failed",
                    "settled"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "borrowerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "targetAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "closeBy": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "borrowerAccountId",
                    "targetAmount",
                    "currency",
                    "closeBy"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "escrowAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "fundingRoundId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "FundingRoundRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "fundingRoundId": {
            "type": "string",
            "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding round instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "funding_round"
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "active",
              "failed",
              "settled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "targetAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "closeBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "borrowerAccountId",
              "targetAmount",
              "currency",
              "closeBy"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "fundingRoundId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementAbandonOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "heldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Held settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "held_settlement"
          },
          "status": {
            "type": "string",
            "const": "abandoned"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party whose money is held until the hold resolves",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payeeAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party the hold protects and pays on release",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting the custody fee",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "heldAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount held in custody, in SAR minor units"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Custody fee charged on top at funding and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for the hold and its fee"
              },
              "releaseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
              },
              "reference": {
                "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "upstreamHeldSettlementId": {
                "type": "string",
                "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
              }
            },
            "required": [
              "payerAccountId",
              "payeeAccountId",
              "platformAccountId",
              "heldAmount",
              "serviceFeeAmount",
              "currency",
              "releaseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "deadlineReleaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "heldSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "heldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Held settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "held_settlement"
          },
          "status": {
            "type": "string",
            "const": "cancelled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party whose money is held until the hold resolves",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payeeAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party the hold protects and pays on release",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting the custody fee",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "heldAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount held in custody, in SAR minor units"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Custody fee charged on top at funding and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for the hold and its fee"
              },
              "releaseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
              },
              "reference": {
                "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "upstreamHeldSettlementId": {
                "type": "string",
                "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
              }
            },
            "required": [
              "payerAccountId",
              "payeeAccountId",
              "platformAccountId",
              "heldAmount",
              "serviceFeeAmount",
              "currency",
              "releaseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "deadlineReleaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "heldSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "payerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Party whose money is held until the hold resolves",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "payeeAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Party the hold protects and pays on release",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "platformAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Workspace revenue or customer balance account collecting the custody fee",
            "x-hyperscale-fee-collection-port": true,
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance",
                "workspace_revenue"
              ]
            }
          },
          "heldAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Amount held in custody, in SAR minor units"
          },
          "serviceFeeAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Custody fee charged on top at funding and never placed in escrow"
          },
          "currency": {
            "type": "string",
            "const": "SAR",
            "description": "One currency for the hold and its fee"
          },
          "releaseDueAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
            "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
          },
          "reference": {
            "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "upstreamHeldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
          }
        },
        "required": [
          "workspaceId",
          "payerAccountId",
          "payeeAccountId",
          "platformAccountId",
          "heldAmount",
          "serviceFeeAmount",
          "currency",
          "releaseDueAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "heldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Held settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "held_settlement"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party whose money is held until the hold resolves",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payeeAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party the hold protects and pays on release",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting the custody fee",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "heldAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount held in custody, in SAR minor units"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Custody fee charged on top at funding and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for the hold and its fee"
              },
              "releaseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
              },
              "reference": {
                "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "upstreamHeldSettlementId": {
                "type": "string",
                "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
              }
            },
            "required": [
              "payerAccountId",
              "payeeAccountId",
              "platformAccountId",
              "heldAmount",
              "serviceFeeAmount",
              "currency",
              "releaseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "deadlineReleaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "heldSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementFundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "heldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Held settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "held_settlement"
          },
          "status": {
            "type": "string",
            "const": "funded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party whose money is held until the hold resolves",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payeeAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party the hold protects and pays on release",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting the custody fee",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "heldAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount held in custody, in SAR minor units"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Custody fee charged on top at funding and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for the hold and its fee"
              },
              "releaseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
              },
              "reference": {
                "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "upstreamHeldSettlementId": {
                "type": "string",
                "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
              }
            },
            "required": [
              "payerAccountId",
              "payeeAccountId",
              "platformAccountId",
              "heldAmount",
              "serviceFeeAmount",
              "currency",
              "releaseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "deadlineReleaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "heldSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "heldSettlementId": {
                  "type": "string",
                  "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Held settlement instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "held_settlement"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "funded",
                    "released",
                    "cancelled",
                    "abandoned"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "payerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Party whose money is held until the hold resolves",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "payeeAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Party the hold protects and pays on release",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "platformAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Workspace revenue or customer balance account collecting the custody fee",
                      "x-hyperscale-fee-collection-port": true,
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance",
                          "workspace_revenue"
                        ]
                      }
                    },
                    "heldAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Amount held in custody, in SAR minor units"
                    },
                    "serviceFeeAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Custody fee charged on top at funding and never placed in escrow"
                    },
                    "currency": {
                      "type": "string",
                      "const": "SAR",
                      "description": "One currency for the hold and its fee"
                    },
                    "releaseDueAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                      "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
                    },
                    "reference": {
                      "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "upstreamHeldSettlementId": {
                      "type": "string",
                      "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
                    }
                  },
                  "required": [
                    "payerAccountId",
                    "payeeAccountId",
                    "platformAccountId",
                    "heldAmount",
                    "serviceFeeAmount",
                    "currency",
                    "releaseDueAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "escrowAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fundingTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "serviceFeeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "releaseTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "deadlineReleaseTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "cancelRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "heldSettlementId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "HeldSettlementReleaseBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "actorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Account of the party taking this action, asserted by the deciding tenant backend and checked against the instance's party bindings",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          }
        },
        "required": [
          "actorAccountId"
        ],
        "additionalProperties": false
      },
      "HeldSettlementReleaseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "heldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Held settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "held_settlement"
          },
          "status": {
            "type": "string",
            "const": "released"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party whose money is held until the hold resolves",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payeeAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party the hold protects and pays on release",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting the custody fee",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "heldAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount held in custody, in SAR minor units"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Custody fee charged on top at funding and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for the hold and its fee"
              },
              "releaseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
              },
              "reference": {
                "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "upstreamHeldSettlementId": {
                "type": "string",
                "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
              }
            },
            "required": [
              "payerAccountId",
              "payeeAccountId",
              "platformAccountId",
              "heldAmount",
              "serviceFeeAmount",
              "currency",
              "releaseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "deadlineReleaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "heldSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HeldSettlementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "heldSettlementId": {
            "type": "string",
            "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Held settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "held_settlement"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "funded",
              "released",
              "cancelled",
              "abandoned"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party whose money is held until the hold resolves",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payeeAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Party the hold protects and pays on release",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting the custody fee",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "heldAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount held in custody, in SAR minor units"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Custody fee charged on top at funding and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for the hold and its fee"
              },
              "releaseDueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
                "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
              },
              "reference": {
                "description": "The tenant's own identifier for what is held: invoice number, project code, contract reference",
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "upstreamHeldSettlementId": {
                "type": "string",
                "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
              }
            },
            "required": [
              "payerAccountId",
              "payeeAccountId",
              "platformAccountId",
              "heldAmount",
              "serviceFeeAmount",
              "currency",
              "releaseDueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "deadlineReleaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "heldSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayAmendCollectBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "rateDifference": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amendmentNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "rateDifference",
          "amendmentNote"
        ],
        "additionalProperties": false
      },
      "HotelStayAmendCollectOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayAmendFeeBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "amendmentFee": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amendmentNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "amendmentFee",
          "amendmentNote"
        ],
        "additionalProperties": false
      },
      "HotelStayAmendFeeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayAmendRefundBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "rateDifference": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "amendmentNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "rateDifference",
          "amendmentNote"
        ],
        "additionalProperties": false
      },
      "HotelStayAmendRefundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayCancelConfirmOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayCancelQuoteOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "cancel_quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayCollectPenaltyOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "penalty_collected"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayConfirmOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "guestAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "propertyAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "rateAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "holdExpiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "checkInAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "checkOutAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "stayNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package this stay is a leg of"
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: lodging_stay. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "guestAccountId",
          "propertyAccountId",
          "rateAmount",
          "currency",
          "holdExpiresAt",
          "checkInAt",
          "checkOutAt",
          "subject"
        ],
        "additionalProperties": false
      },
      "HotelStayCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "held"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "hotelStayId": {
                  "type": "string",
                  "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hotel stay instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "hotel_stay"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "held",
                    "released",
                    "confirmed",
                    "cancel_quoted",
                    "completed",
                    "canceled",
                    "penalty_collected",
                    "package_canceled",
                    "expired"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "guestAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "propertyAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "rateAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "holdExpiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "checkInAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "checkOutAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "stayNote": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "travelPackageId": {
                      "type": "string",
                      "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Travel package this stay is a leg of"
                    }
                  },
                  "required": [
                    "guestAccountId",
                    "propertyAccountId",
                    "rateAmount",
                    "currency",
                    "holdExpiresAt",
                    "checkInAt",
                    "checkOutAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "rateReserveAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "rateTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "amendCollectTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "amendRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "amendFeeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "penaltyTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "packageRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "ratePayoutTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindRefund": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindPenalty": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "hotelStayId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "HotelStayReleaseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "const": "released"
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "enum": [
              "held",
              "released",
              "confirmed",
              "cancel_quoted",
              "completed",
              "canceled",
              "penalty_collected",
              "package_canceled",
              "expired"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HotelStayUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "checkInAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "checkOutAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "stayNote": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "HotelStayUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "hotelStayId": {
            "type": "string",
            "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hotel stay instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "hotel_stay"
          },
          "status": {
            "type": "string",
            "enum": [
              "held",
              "confirmed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "guestAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "propertyAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "rateAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "holdExpiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkInAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "checkOutAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "stayNote": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "travelPackageId": {
                "type": "string",
                "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Travel package this stay is a leg of"
              }
            },
            "required": [
              "guestAccountId",
              "propertyAccountId",
              "rateAmount",
              "currency",
              "holdExpiresAt",
              "checkInAt",
              "checkOutAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "rateReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "rateTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendCollectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "amendFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "packageRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "ratePayoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "hotelStayId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "HyperscaleError": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/HyperscaleError/$defs/HyperscaleErrorBody"
          },
          "requestId": {
            "type": "string"
          }
        },
        "required": [
          "error",
          "requestId"
        ],
        "additionalProperties": false,
        "$defs": {
          "HyperscaleErrorBody": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "details": {
                "$ref": "#/components/schemas/HyperscaleError/$defs/HyperscaleErrorDetails"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "code",
              "message"
            ],
            "additionalProperties": false
          },
          "HyperscaleErrorDetails": {
            "description": "Operation-specific structured error details. Validation failures use ValidationErrorDetails; other errors may return any JSON value.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/HyperscaleError/$defs/ValidationErrorDetails"
              },
              {
                "type": "object",
                "additionalProperties": true
              }
            ]
          },
          "ValidationErrorDetails": {
            "type": "object",
            "properties": {
              "issues": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/HyperscaleError/$defs/ValidationIssue"
                }
              }
            },
            "required": [
              "issues"
            ],
            "additionalProperties": false
          },
          "ValidationIssue": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "path": {
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "number"
                    }
                  ]
                }
              }
            },
            "required": [
              "code",
              "message",
              "path"
            ],
            "additionalProperties": false
          }
        }
      },
      "InstallmentCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "agreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement this installment repays"
          },
          "borrowerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "fundingAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "dueAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "agreementId",
          "borrowerAccountId",
          "fundingAccountId",
          "amount",
          "currency",
          "dueAt"
        ],
        "additionalProperties": false
      },
      "InstallmentCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "installmentId": {
            "type": "string",
            "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Installment instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "installment"
          },
          "status": {
            "type": "string",
            "const": "scheduled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this installment repays"
              },
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "dueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "borrowerAccountId",
              "fundingAccountId",
              "amount",
              "currency",
              "dueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "collectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "installmentId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "InstallmentListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "installmentId": {
                  "type": "string",
                  "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Installment instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "installment"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "scheduled",
                    "overdue",
                    "collected",
                    "written_off"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "agreementId": {
                      "type": "string",
                      "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Credit agreement this installment repays"
                    },
                    "borrowerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "fundingAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "dueAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "agreementId",
                    "borrowerAccountId",
                    "fundingAccountId",
                    "amount",
                    "currency",
                    "dueAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "collectTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "installmentId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "InstallmentRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "installmentId": {
            "type": "string",
            "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Installment instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "installment"
          },
          "status": {
            "type": "string",
            "enum": [
              "scheduled",
              "overdue",
              "collected",
              "written_off"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this installment repays"
              },
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "dueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "borrowerAccountId",
              "fundingAccountId",
              "amount",
              "currency",
              "dueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "collectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "installmentId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "InstallmentUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "InstallmentUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "installmentId": {
            "type": "string",
            "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Installment instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "installment"
          },
          "status": {
            "type": "string",
            "enum": [
              "scheduled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this installment repays"
              },
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "dueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "borrowerAccountId",
              "fundingAccountId",
              "amount",
              "currency",
              "dueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "collectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "installmentId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "InstallmentWriteOffOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "installmentId": {
            "type": "string",
            "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Installment instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "installment"
          },
          "status": {
            "type": "string",
            "const": "written_off"
          },
          "fields": {
            "type": "object",
            "properties": {
              "agreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement this installment repays"
              },
              "borrowerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "fundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "dueAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "agreementId",
              "borrowerAccountId",
              "fundingAccountId",
              "amount",
              "currency",
              "dueAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "collectTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "installmentId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "InternalTransferAdjustBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "amount",
          "currency",
          "reason"
        ],
        "additionalProperties": false
      },
      "InternalTransferAdjustOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "originalTransferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "transferStatus": {
            "type": "string",
            "const": "posted"
          }
        },
        "required": [
          "tenantId",
          "originalTransferId",
          "transferId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "transferStatus"
        ],
        "additionalProperties": false
      },
      "InternalTransferCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "metadata": {
            "$ref": "#/components/schemas/InternalTransferCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/InternalTransferCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/InternalTransferCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/InternalTransferCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/InternalTransferCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "InternalTransferCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "fee": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "legs": {
                "minItems": 1,
                "maxItems": 3,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "provider",
                        "workspace",
                        "platform"
                      ]
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "transferId": {
                      "type": "string",
                      "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale transfer ID"
                    },
                    "accountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID"
                    }
                  },
                  "required": [
                    "kind",
                    "amount",
                    "transferId",
                    "accountId"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "amount",
              "currency",
              "legs"
            ],
            "additionalProperties": false
          },
          "netAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "metadata": {
            "$ref": "#/components/schemas/InternalTransferCreateOutput/$defs/Metadata"
          },
          "transferStatus": {
            "type": "string",
            "const": "posted"
          }
        },
        "required": [
          "transferId",
          "tenantId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "metadata",
          "transferStatus"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/InternalTransferCreateOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/InternalTransferCreateOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/InternalTransferCreateOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/InternalTransferCreateOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "InternalTransferListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "transferId": {
                  "type": "string",
                  "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale transfer ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "postedAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "sourceAccountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "destinationAccountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "accepted",
                    "reserved",
                    "posted",
                    "voided",
                    "failed"
                  ]
                },
                "expiresAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "expiredAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "metadata": {
                  "$ref": "#/components/schemas/InternalTransferListOutput/$defs/Metadata"
                },
                "correctsTransferId": {
                  "type": "string",
                  "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale transfer ID"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "transferId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/InternalTransferListOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/InternalTransferListOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/InternalTransferListOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/InternalTransferListOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "InternalTransferPostBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "postMode": {
            "type": "string",
            "enum": [
              "partial_only"
            ]
          }
        },
        "additionalProperties": false
      },
      "InternalTransferPostOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "transferStatus": {
            "type": "string",
            "enum": [
              "posted",
              "reserved"
            ]
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "postedAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "remainingReservedAmount": {
            "type": "string",
            "pattern": "^\\d+$"
          }
        },
        "required": [
          "tenantId",
          "transferId",
          "transferStatus",
          "amount",
          "currency",
          "postedAmount",
          "remainingReservedAmount"
        ],
        "additionalProperties": false
      },
      "InternalTransferReserveInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "metadata": {
            "$ref": "#/components/schemas/InternalTransferReserveInput/$defs/Metadata"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/InternalTransferReserveInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/InternalTransferReserveInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/InternalTransferReserveInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/InternalTransferReserveInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "InternalTransferReserveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "metadata": {
            "$ref": "#/components/schemas/InternalTransferReserveOutput/$defs/Metadata"
          },
          "transferStatus": {
            "type": "string",
            "const": "reserved"
          }
        },
        "required": [
          "transferId",
          "tenantId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "metadata",
          "transferStatus"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/InternalTransferReserveOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/InternalTransferReserveOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/InternalTransferReserveOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/InternalTransferReserveOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "InternalTransferRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "transferId": {
                "type": "string",
                "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale transfer ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "postedAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "sourceAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "destinationAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "status": {
                "type": "string",
                "enum": [
                  "accepted",
                  "reserved",
                  "posted",
                  "voided",
                  "failed"
                ]
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiredAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "metadata": {
                "$ref": "#/components/schemas/InternalTransferRetrieveOutput/$defs/Metadata"
              },
              "correctsTransferId": {
                "type": "string",
                "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale transfer ID"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "transferId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/InternalTransferRetrieveOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/InternalTransferRetrieveOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/InternalTransferRetrieveOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/InternalTransferRetrieveOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "InternalTransferReverseBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "InternalTransferReverseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "originalTransferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "transferStatus": {
            "type": "string",
            "const": "posted"
          }
        },
        "required": [
          "tenantId",
          "originalTransferId",
          "transferId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "transferStatus"
        ],
        "additionalProperties": false
      },
      "InternalTransferVoidBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "InternalTransferVoidOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "transferStatus": {
            "type": "string",
            "const": "voided"
          }
        },
        "required": [
          "tenantId",
          "transferId",
          "transferStatus"
        ],
        "additionalProperties": false
      },
      "InvoiceLineListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "invoiceLineId": {
                  "type": "string",
                  "pattern": "^invl_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice line ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "invoiceId": {
                  "type": "string",
                  "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice ID"
                },
                "description": {
                  "type": "string"
                },
                "meter": {
                  "type": "string"
                },
                "quantity": {
                  "type": "string"
                },
                "unitAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "subtotalAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "invoiceLineId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "InvoiceLineRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "invoiceLineId": {
                "type": "string",
                "pattern": "^invl_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice line ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "invoiceId": {
                "type": "string",
                "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice ID"
              },
              "description": {
                "type": "string"
              },
              "meter": {
                "type": "string"
              },
              "quantity": {
                "type": "string"
              },
              "unitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "subtotalAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "invoiceLineId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "InvoiceListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "invoiceId": {
                  "type": "string",
                  "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale invoice ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "billingPeriodId": {
                  "type": "string",
                  "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing period ID"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "draft",
                    "finalized",
                    "charged",
                    "paid",
                    "voided",
                    "credited"
                  ]
                },
                "subtotalAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "creditAppliedAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "totalAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "finalizedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "invoiceId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "InvoiceRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "invoiceId": {
                "type": "string",
                "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale invoice ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "billingPeriodId": {
                "type": "string",
                "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing period ID"
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "finalized",
                  "charged",
                  "paid",
                  "voided",
                  "credited"
                ]
              },
              "subtotalAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "creditAppliedAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "totalAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "finalizedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "invoiceId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "KycRequirementsRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[A-Z]{2}$",
            "description": "ISO 3166-1 alpha-2 country code"
          },
          "tiers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "tier": {
                  "type": "string",
                  "enum": [
                    "basic",
                    "standard",
                    "investment"
                  ]
                },
                "level": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 3,
                  "description": "Numeric level of this tier on the 0-3 ladder (level 0 is the absence of verification, never a rung)."
                },
                "name": {
                  "type": "string"
                },
                "summary": {
                  "type": "string"
                },
                "fieldGroups": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "identity",
                      "personal",
                      "address",
                      "education",
                      "financial_profile",
                      "employment",
                      "investment_experience",
                      "declarations",
                      "tax_residency",
                      "consent"
                    ]
                  }
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "group": {
                        "type": "string",
                        "enum": [
                          "identity",
                          "personal",
                          "address",
                          "education",
                          "financial_profile",
                          "employment",
                          "investment_experience",
                          "declarations",
                          "tax_residency",
                          "consent"
                        ]
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "text",
                          "boolean",
                          "integer",
                          "enum",
                          "multi_enum",
                          "country"
                        ]
                      },
                      "label": {
                        "type": "string"
                      },
                      "values": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "pattern": {
                        "type": "string"
                      },
                      "optional": {
                        "type": "boolean"
                      },
                      "dependsOn": {
                        "type": "object",
                        "properties": {
                          "key": {
                            "type": "string"
                          },
                          "equals": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "key",
                          "equals"
                        ],
                        "additionalProperties": false
                      },
                      "mustEqual": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "key",
                      "group",
                      "type",
                      "label"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "tier",
                "level",
                "name",
                "summary",
                "fieldGroups",
                "fields"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "country",
          "tiers"
        ],
        "additionalProperties": false
      },
      "LenderDistributionCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "creditAgreementId": {
            "type": "string",
            "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Credit agreement whose repaid pool this claim draws from"
          },
          "fundingRoundId": {
            "type": "string",
            "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Funding round shared by the agreement and the commitment"
          },
          "fundingCommitmentId": {
            "type": "string",
            "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Collected pledge this distribution pays back"
          },
          "claimedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "workspaceId",
          "creditAgreementId",
          "fundingRoundId",
          "fundingCommitmentId",
          "claimedAt"
        ],
        "additionalProperties": false
      },
      "LenderDistributionCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "lenderDistributionId": {
            "type": "string",
            "pattern": "^lnd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Lender distribution instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "lender_distribution"
          },
          "status": {
            "type": "string",
            "const": "claimed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "creditAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement whose repaid pool this claim draws from"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round shared by the agreement and the commitment"
              },
              "fundingCommitmentId": {
                "type": "string",
                "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Collected pledge this distribution pays back"
              },
              "lenderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "poolAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "claimedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditAgreementId",
              "fundingRoundId",
              "fundingCommitmentId",
              "lenderAccountId",
              "poolAccountId",
              "amount",
              "currency",
              "claimedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "payoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "payoutShare": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "lenderDistributionId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "LenderDistributionListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lenderDistributionId": {
                  "type": "string",
                  "pattern": "^lnd_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Lender distribution instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "lender_distribution"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "claimed",
                    "paid"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "creditAgreementId": {
                      "type": "string",
                      "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Credit agreement whose repaid pool this claim draws from"
                    },
                    "fundingRoundId": {
                      "type": "string",
                      "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Funding round shared by the agreement and the commitment"
                    },
                    "fundingCommitmentId": {
                      "type": "string",
                      "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Collected pledge this distribution pays back"
                    },
                    "lenderAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "poolAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "claimedAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "creditAgreementId",
                    "fundingRoundId",
                    "fundingCommitmentId",
                    "lenderAccountId",
                    "poolAccountId",
                    "amount",
                    "currency",
                    "claimedAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "payoutTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "payoutShare": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "lenderDistributionId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "LenderDistributionRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "lenderDistributionId": {
            "type": "string",
            "pattern": "^lnd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Lender distribution instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "lender_distribution"
          },
          "status": {
            "type": "string",
            "enum": [
              "claimed",
              "paid"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "creditAgreementId": {
                "type": "string",
                "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Credit agreement whose repaid pool this claim draws from"
              },
              "fundingRoundId": {
                "type": "string",
                "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Funding round shared by the agreement and the commitment"
              },
              "fundingCommitmentId": {
                "type": "string",
                "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Collected pledge this distribution pays back"
              },
              "lenderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "poolAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "claimedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "creditAgreementId",
              "fundingRoundId",
              "fundingCommitmentId",
              "lenderAccountId",
              "poolAccountId",
              "amount",
              "currency",
              "claimedAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "payoutTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "payoutShare": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "lenderDistributionId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "sellerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "headline": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "description": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "askingPrice": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "imageUrl": {
            "type": "string",
            "maxLength": 2000,
            "format": "uri"
          },
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order whose held funds reserve this listing"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle, merchandise. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "sellerAccountId",
          "headline",
          "askingPrice",
          "currency",
          "subject"
        ],
        "additionalProperties": false
      },
      "ListingCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "const": "draft"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "listingId": {
                  "type": "string",
                  "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Listing instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "listing"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "draft",
                    "active",
                    "reserved",
                    "sold",
                    "withdrawn"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "sellerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "headline": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "description": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "askingPrice": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "imageUrl": {
                      "type": "string",
                      "maxLength": 2000,
                      "format": "uri"
                    },
                    "escrowOrderId": {
                      "type": "string",
                      "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Escrow order whose held funds reserve this listing"
                    },
                    "expiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "sellerAccountId",
                    "headline",
                    "askingPrice",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "listingId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ListingPublishOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingReopenOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingReserveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "const": "reserved"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active",
              "reserved",
              "sold",
              "withdrawn"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingSellOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "const": "sold"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "headline": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "description": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "askingPrice": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "imageUrl": {
            "type": "string",
            "maxLength": 2000,
            "format": "uri"
          },
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order whose held funds reserve this listing"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "additionalProperties": false
      },
      "ListingUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ListingWithdrawOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "listing"
          },
          "status": {
            "type": "string",
            "const": "withdrawn"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "imageUrl": {
                "type": "string",
                "maxLength": 2000,
                "format": "uri"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order whose held funds reserve this listing"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "listingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MeterPeriodSnapshotListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "meterPeriodSnapshotId": {
                  "type": "string",
                  "pattern": "^mps_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale meter period snapshot ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "billingPeriodId": {
                  "type": "string",
                  "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale billing period ID"
                },
                "meter": {
                  "type": "string"
                },
                "quantity": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "meterPeriodSnapshotId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "MeterPeriodSnapshotRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "meterPeriodSnapshotId": {
                "type": "string",
                "pattern": "^mps_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale meter period snapshot ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "billingPeriodId": {
                "type": "string",
                "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale billing period ID"
              },
              "meter": {
                "type": "string"
              },
              "quantity": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "meterPeriodSnapshotId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "MotorPolicyBindOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicyCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicyCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "policyholderAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "insurerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "premiumAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "coverageAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "coverageDescription": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "policyholderAccountId",
          "insurerAccountId",
          "premiumAmount",
          "coverageAmount",
          "currency",
          "expiresAt",
          "subject"
        ],
        "additionalProperties": false
      },
      "MotorPolicyCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "const": "quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicyDenyClaimOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "const": "denied"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicyListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "motorPolicyId": {
                  "type": "string",
                  "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Motor policy instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "motor_policy"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "quoted",
                    "active",
                    "claim_open",
                    "settled",
                    "denied",
                    "expired",
                    "canceled"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "policyholderAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "insurerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "premiumAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "coverageAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "expiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "coverageDescription": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "policyholderAccountId",
                    "insurerAccountId",
                    "premiumAmount",
                    "coverageAmount",
                    "currency",
                    "expiresAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "premiumTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "claimTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "motorPolicyId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "MotorPolicyOpenClaimOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "const": "claim_open"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicyRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "enum": [
              "quoted",
              "active",
              "claim_open",
              "settled",
              "denied",
              "expired",
              "canceled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicySettleClaimOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "const": "settled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "MotorPolicyUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "coverageDescription": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "MotorPolicyUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "motorPolicyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "motor_policy"
          },
          "status": {
            "type": "string",
            "enum": [
              "quoted"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "coverageDescription": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageAmount",
              "currency",
              "expiresAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "claimTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "motorPolicyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "OperationListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "operationId": {
                  "type": "string",
                  "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale operation ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "name": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "accepted",
                    "pending",
                    "succeeded",
                    "failed"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "operationId",
                "name"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "OperationRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "operationId": {
                "type": "string",
                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale operation ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "name": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "accepted",
                  "pending",
                  "succeeded",
                  "failed"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "operationId",
              "name"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "OrderCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "order"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject the buyer agreed to purchase"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order holding this order's purchase money"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "confirmBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "escrowOrderId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "orderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "OrderConfirmOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "order"
          },
          "status": {
            "type": "string",
            "const": "confirmed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject the buyer agreed to purchase"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order holding this order's purchase money"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "confirmBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "escrowOrderId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "orderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "OrderCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "listingId": {
            "type": "string",
            "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Listing whose subject the buyer agreed to purchase"
          },
          "escrowOrderId": {
            "type": "string",
            "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Escrow order holding this order's purchase money"
          },
          "confirmBy": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle, merchandise. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "listingId",
          "escrowOrderId",
          "subject"
        ],
        "additionalProperties": false
      },
      "OrderCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "order"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject the buyer agreed to purchase"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order holding this order's purchase money"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "confirmBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "escrowOrderId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "orderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "OrderFulfillOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "order"
          },
          "status": {
            "type": "string",
            "const": "fulfilled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject the buyer agreed to purchase"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order holding this order's purchase money"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "confirmBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "escrowOrderId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "orderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "OrderListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "orderId": {
                  "type": "string",
                  "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Order instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "order"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "confirmed",
                    "fulfilled",
                    "canceled",
                    "expired"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "buyerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "sellerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "listingId": {
                      "type": "string",
                      "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Listing whose subject the buyer agreed to purchase"
                    },
                    "escrowOrderId": {
                      "type": "string",
                      "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Escrow order holding this order's purchase money"
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "confirmBy": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "buyerAccountId",
                    "sellerAccountId",
                    "listingId",
                    "escrowOrderId",
                    "amount",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "orderId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "OrderRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "order"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "confirmed",
              "fulfilled",
              "canceled",
              "expired"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject the buyer agreed to purchase"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order holding this order's purchase money"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "confirmBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "escrowOrderId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "orderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "OrderUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "confirmBy": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "OrderUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Order instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "order"
          },
          "status": {
            "type": "string",
            "enum": [
              "created"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "listingId": {
                "type": "string",
                "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Listing whose subject the buyer agreed to purchase"
              },
              "escrowOrderId": {
                "type": "string",
                "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Escrow order holding this order's purchase money"
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "confirmBy": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "listingId",
              "escrowOrderId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "orderId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PayoutCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutId": {
            "type": "string",
            "pattern": "^pay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale payout ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "beneficiaryId": {
            "type": "string",
            "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale beneficiary ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "speed": {
            "type": "string",
            "enum": [
              "instant",
              "standard"
            ]
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "metadata": {
            "$ref": "#/components/schemas/PayoutCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "sourceAccountId",
          "beneficiaryId",
          "amount",
          "currency",
          "speed"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/PayoutCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PayoutCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PayoutCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/PayoutCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "PayoutCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutId": {
            "type": "string",
            "pattern": "^pay_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale payout ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "beneficiaryId": {
            "type": "string",
            "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale beneficiary ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "speed": {
            "type": "string",
            "enum": [
              "instant",
              "standard"
            ]
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "estimatedCompletionAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "metadata": {
            "$ref": "#/components/schemas/PayoutCreateOutput/$defs/Metadata"
          }
        },
        "required": [
          "payoutId",
          "tenantId",
          "sourceAccountId",
          "beneficiaryId",
          "amount",
          "currency",
          "speed",
          "status",
          "createdAt",
          "metadata"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/PayoutCreateOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PayoutCreateOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PayoutCreateOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/PayoutCreateOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "PayoutListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "payoutId": {
                  "type": "string",
                  "pattern": "^pay_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale payout ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "sourceAccountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "beneficiaryId": {
                  "type": "string",
                  "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale beneficiary ID"
                },
                "amount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "currency": {
                  "type": "string"
                },
                "speed": {
                  "type": "string"
                },
                "transferId": {
                  "type": "string",
                  "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale transfer ID"
                },
                "estimatedCompletionAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "failureReason": {
                  "type": "string"
                },
                "returnReason": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "processing",
                    "completed",
                    "failed",
                    "returned"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "payoutId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "PayoutRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "payoutId": {
                "type": "string",
                "pattern": "^pay_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale payout ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "sourceAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "beneficiaryId": {
                "type": "string",
                "pattern": "^ben_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale beneficiary ID"
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string"
              },
              "speed": {
                "type": "string"
              },
              "transferId": {
                "type": "string",
                "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale transfer ID"
              },
              "estimatedCompletionAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "failureReason": {
                "type": "string"
              },
              "returnReason": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "created",
                  "processing",
                  "completed",
                  "failed",
                  "returned"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "payoutId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "PayoutRunCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutRunId": {
            "type": "string",
            "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Payout run instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "payout_run"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "earnerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payoutFundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "withholdingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "netAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "withholdingAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "runAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "earnerAccountId",
              "payoutFundingAccountId",
              "withholdingAccountId",
              "netAmount",
              "withholdingAmount",
              "currency",
              "runAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "withholdingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "netTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "payoutRunId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PayoutRunCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "earnerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "payoutFundingAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "withholdingAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "netAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "withholdingAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "runAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "earnerAccountId",
          "payoutFundingAccountId",
          "withholdingAccountId",
          "netAmount",
          "withholdingAmount",
          "currency",
          "runAt"
        ],
        "additionalProperties": false
      },
      "PayoutRunCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutRunId": {
            "type": "string",
            "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Payout run instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "payout_run"
          },
          "status": {
            "type": "string",
            "const": "scheduled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "earnerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payoutFundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "withholdingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "netAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "withholdingAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "runAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "earnerAccountId",
              "payoutFundingAccountId",
              "withholdingAccountId",
              "netAmount",
              "withholdingAmount",
              "currency",
              "runAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "withholdingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "netTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "payoutRunId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PayoutRunListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "payoutRunId": {
                  "type": "string",
                  "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Payout run instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "payout_run"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "scheduled",
                    "withheld",
                    "executed",
                    "canceled"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "earnerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "payoutFundingAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "withholdingAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "netAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "withholdingAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "runAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "earnerAccountId",
                    "payoutFundingAccountId",
                    "withholdingAccountId",
                    "netAmount",
                    "withholdingAmount",
                    "currency",
                    "runAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "withholdingTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "netTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "payoutRunId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "PayoutRunRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutRunId": {
            "type": "string",
            "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Payout run instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "payout_run"
          },
          "status": {
            "type": "string",
            "enum": [
              "scheduled",
              "withheld",
              "executed",
              "canceled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "earnerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payoutFundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "withholdingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "netAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "withholdingAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "runAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "earnerAccountId",
              "payoutFundingAccountId",
              "withholdingAccountId",
              "netAmount",
              "withholdingAmount",
              "currency",
              "runAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "withholdingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "netTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "payoutRunId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PayoutRunUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "PayoutRunUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutRunId": {
            "type": "string",
            "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Payout run instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "payout_run"
          },
          "status": {
            "type": "string",
            "enum": [
              "scheduled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "earnerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payoutFundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "withholdingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "netAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "withholdingAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "runAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "earnerAccountId",
              "payoutFundingAccountId",
              "withholdingAccountId",
              "netAmount",
              "withholdingAmount",
              "currency",
              "runAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "withholdingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "netTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "payoutRunId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PayoutRunWithholdOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "payoutRunId": {
            "type": "string",
            "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Payout run instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "payout_run"
          },
          "status": {
            "type": "string",
            "const": "withheld"
          },
          "fields": {
            "type": "object",
            "properties": {
              "earnerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "payoutFundingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "withholdingAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "netAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "withholdingAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "runAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "earnerAccountId",
              "payoutFundingAccountId",
              "withholdingAccountId",
              "netAmount",
              "withholdingAmount",
              "currency",
              "runAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "withholdingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "netTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "payoutRunId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyBindOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "const": "bound"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "policyholderAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "insurerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "premiumAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "coverageLimit": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "startsAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "perilSchedule": {
            "minItems": 1,
            "maxItems": 24,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "peril": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                },
                "limitAmount": {
                  "type": "string",
                  "pattern": "^[1-9][0-9]{0,17}$",
                  "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "deductibleBps": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 10000
                },
                "waitingPeriodDays": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 3650
                }
              },
              "required": [
                "peril",
                "limitAmount",
                "deductibleBps",
                "waitingPeriodDays"
              ],
              "additionalProperties": false
            }
          },
          "termsSummary": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000
          },
          "renewalOfPolicyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Prior policy this quote renews; the prior term must be active or already expired"
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: policy_risk, flight_itinerary, lodging_stay, vehicle, pet, traveler_party, employee_census. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "policyholderAccountId",
          "insurerAccountId",
          "premiumAmount",
          "coverageLimit",
          "currency",
          "startsAt",
          "expiresAt",
          "perilSchedule",
          "subject"
        ],
        "additionalProperties": false
      },
      "PolicyCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "const": "quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyEndorseBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "perilSchedule": {
            "minItems": 1,
            "maxItems": 24,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "peril": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                },
                "limitAmount": {
                  "type": "string",
                  "pattern": "^[1-9][0-9]{0,17}$",
                  "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "deductibleBps": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 10000
                },
                "waitingPeriodDays": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 3650
                }
              },
              "required": [
                "peril",
                "limitAmount",
                "deductibleBps",
                "waitingPeriodDays"
              ],
              "additionalProperties": false
            }
          },
          "termsSummary": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "additionalProperties": false
      },
      "PolicyEndorseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "policyId": {
                  "type": "string",
                  "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Policy instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "policy"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "quoted",
                    "bound",
                    "active",
                    "cancel_quoted",
                    "canceled",
                    "expired"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "policyholderAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "insurerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "premiumAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "coverageLimit": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "startsAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "expiresAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "perilSchedule": {
                      "minItems": 1,
                      "maxItems": 24,
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "peril": {
                            "type": "string",
                            "pattern": "^[a-z][a-z0-9_]{1,79}$"
                          },
                          "limitAmount": {
                            "type": "string",
                            "pattern": "^[1-9][0-9]{0,17}$",
                            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                          },
                          "deductibleBps": {
                            "type": "integer",
                            "minimum": 0,
                            "maximum": 10000
                          },
                          "waitingPeriodDays": {
                            "type": "integer",
                            "minimum": 0,
                            "maximum": 3650
                          }
                        },
                        "required": [
                          "peril",
                          "limitAmount",
                          "deductibleBps",
                          "waitingPeriodDays"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "termsSummary": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1000
                    },
                    "renewalOfPolicyId": {
                      "type": "string",
                      "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Prior policy this quote renews; the prior term must be active or already expired"
                    }
                  },
                  "required": [
                    "policyholderAccountId",
                    "insurerAccountId",
                    "premiumAmount",
                    "coverageLimit",
                    "currency",
                    "startsAt",
                    "expiresAt",
                    "perilSchedule"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "premiumReserveAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "premiumFundingTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "premiumTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "premiumRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindRefund": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindPenalty": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "policyId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "PolicyPreviewOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "const": "cancel_quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "enum": [
              "quoted",
              "bound",
              "active",
              "cancel_quoted",
              "canceled",
              "expired"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "startsAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "perilSchedule": {
            "minItems": 1,
            "maxItems": 24,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "peril": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{1,79}$"
                },
                "limitAmount": {
                  "type": "string",
                  "pattern": "^[1-9][0-9]{0,17}$",
                  "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "deductibleBps": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 10000
                },
                "waitingPeriodDays": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 3650
                }
              },
              "required": [
                "peril",
                "limitAmount",
                "deductibleBps",
                "waitingPeriodDays"
              ],
              "additionalProperties": false
            }
          },
          "termsSummary": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000
          }
        },
        "additionalProperties": false
      },
      "PolicyUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "enum": [
              "quoted"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "PolicyWithdrawOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "policyId": {
            "type": "string",
            "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Policy instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "policy"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "policyholderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "insurerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "premiumAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "coverageLimit": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startsAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "perilSchedule": {
                "minItems": 1,
                "maxItems": 24,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "peril": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,79}$"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "deductibleBps": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10000
                    },
                    "waitingPeriodDays": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 3650
                    }
                  },
                  "required": [
                    "peril",
                    "limitAmount",
                    "deductibleBps",
                    "waitingPeriodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "termsSummary": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              },
              "renewalOfPolicyId": {
                "type": "string",
                "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Prior policy this quote renews; the prior term must be active or already expired"
              }
            },
            "required": [
              "policyholderAccountId",
              "insurerAccountId",
              "premiumAmount",
              "coverageLimit",
              "currency",
              "startsAt",
              "expiresAt",
              "perilSchedule"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "premiumReserveAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "premiumRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "policyId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "ProductListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductListOutput/$defs/ProductListItem"
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false,
        "$defs": {
          "ProductListItem": {
            "type": "object",
            "properties": {
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "environment": {
                "type": "string",
                "enum": [
                  "sandbox",
                  "live"
                ]
              },
              "displayName": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "app",
                  "offering",
                  "listing",
                  "booking",
                  "pool"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "active",
                  "disabled",
                  "closed"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "blueprint": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/ProductListOutput/$defs/ProductBlueprintRef"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "workspaceId",
              "tenantId",
              "environment",
              "displayName",
              "slug",
              "kind",
              "status",
              "createdAt",
              "blueprint"
            ],
            "additionalProperties": false
          },
          "ProductBlueprintRef": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_-]{2,80}$",
                "description": "Commercial blueprint ID"
              },
              "name": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          }
        }
      },
      "ProductRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "displayName": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "app",
              "offering",
              "listing",
              "booking",
              "pool"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "disabled",
              "closed"
            ]
          },
          "blueprint": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductBlueprintRef"
              },
              {
                "type": "null"
              }
            ]
          },
          "nounIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "plan": {
            "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductPlanView"
          },
          "readiness": {
            "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/WorkspaceActivationReadiness"
          },
          "capabilities": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductCapability"
            }
          },
          "cost": {
            "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/WorkspaceLiveCostEstimate"
          },
          "surfaces": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductSurfaces"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "workspaceId",
          "tenantId",
          "environment",
          "displayName",
          "slug",
          "kind",
          "status",
          "blueprint",
          "nounIds",
          "plan",
          "readiness",
          "capabilities",
          "cost",
          "surfaces"
        ],
        "additionalProperties": false,
        "$defs": {
          "ProductBlueprintRef": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_-]{2,80}$",
                "description": "Commercial blueprint ID"
              },
              "name": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          },
          "ProductPlanView": {
            "type": "object",
            "properties": {
              "monthlySar": {
                "type": "string"
              },
              "setupSar": {
                "type": "string"
              },
              "complexityScore": {
                "anyOf": [
                  {
                    "type": "number"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "rates": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductPlanRate"
                }
              }
            },
            "required": [
              "monthlySar",
              "setupSar",
              "complexityScore",
              "rates"
            ],
            "additionalProperties": false
          },
          "ProductPlanRate": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "kind": {
                "type": "string"
              },
              "meter": {
                "type": "string",
                "enum": [
                  "account.active_month",
                  "account.created.count",
                  "financial_address.issued.count",
                  "financial_address.active_month",
                  "transfer.internal.count",
                  "transfer.internal.volume_sar",
                  "deposit.attributed.count",
                  "deposit.attributed.volume_sar",
                  "payout.external.count",
                  "payout.external.volume_sar",
                  "collection.pay_in.count",
                  "collection.pay_in.volume_sar",
                  "noun.event.count",
                  "noun.event.volume_sar",
                  "kyb.application.review",
                  "verification.kyc.basic.count",
                  "verification.kyc.standard.count",
                  "verification.kyc.investment.count",
                  "verification.kyb.count",
                  "operation.executed.count",
                  "api.read.count",
                  "billing.invoice.settlement",
                  "billing.plan.recurring_month",
                  "billing.product.activation"
                ]
              },
              "unit": {
                "type": "string"
              },
              "amountSar": {
                "type": "string"
              },
              "bps": {
                "type": "string"
              },
              "includedQuantity": {
                "type": "string"
              },
              "summary": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "kind",
              "meter",
              "unit",
              "summary"
            ],
            "additionalProperties": false
          },
          "WorkspaceActivationReadiness": {
            "type": "object",
            "properties": {
              "live": {
                "type": "boolean"
              },
              "outstandingLiveRequirements": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "liveUnavailableCapabilities": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "organization",
                    "identity",
                    "accounts",
                    "deposits",
                    "internal_transfers",
                    "payouts",
                    "beneficiary_verification",
                    "workspaces",
                    "activity",
                    "usage",
                    "billing",
                    "webhooks",
                    "verification",
                    "cardholder",
                    "card",
                    "card_authorization",
                    "card_transaction",
                    "card_dispute",
                    "escrow_order",
                    "listing",
                    "order",
                    "policy",
                    "claim",
                    "motor_policy",
                    "vehicle_escrow",
                    "vehicle_listing",
                    "flight_booking",
                    "hotel_stay",
                    "travel_package",
                    "wallet",
                    "wallet_spend",
                    "credit_agreement",
                    "installment",
                    "exposure_arrangement",
                    "collections_case",
                    "contact_attempt",
                    "payout_run",
                    "funding_round",
                    "funding_commitment",
                    "lender_distribution",
                    "savings_circle",
                    "circle_membership",
                    "sale_settlement",
                    "trade_settlement",
                    "held_settlement"
                  ]
                }
              }
            },
            "required": [
              "live",
              "outstandingLiveRequirements",
              "liveUnavailableCapabilities"
            ],
            "additionalProperties": false
          },
          "ProductCapability": {
            "type": "object",
            "properties": {
              "capabilityId": {
                "type": "string",
                "enum": [
                  "organization",
                  "identity",
                  "accounts",
                  "deposits",
                  "internal_transfers",
                  "payouts",
                  "beneficiary_verification",
                  "workspaces",
                  "activity",
                  "usage",
                  "billing",
                  "webhooks",
                  "verification",
                  "cardholder",
                  "card",
                  "card_authorization",
                  "card_transaction",
                  "card_dispute",
                  "escrow_order",
                  "listing",
                  "order",
                  "policy",
                  "claim",
                  "motor_policy",
                  "vehicle_escrow",
                  "vehicle_listing",
                  "flight_booking",
                  "hotel_stay",
                  "travel_package",
                  "wallet",
                  "wallet_spend",
                  "credit_agreement",
                  "installment",
                  "exposure_arrangement",
                  "collections_case",
                  "contact_attempt",
                  "payout_run",
                  "funding_round",
                  "funding_commitment",
                  "lender_distribution",
                  "savings_circle",
                  "circle_membership",
                  "sale_settlement",
                  "trade_settlement",
                  "held_settlement"
                ]
              },
              "name": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "capabilityId",
              "name"
            ],
            "additionalProperties": false
          },
          "WorkspaceLiveCostEstimate": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string",
                "const": "SAR"
              },
              "platformMonthlySar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "platformSetupSar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "liveCapableCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "recurringCharges": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/WorkspaceLiveCostCharge"
                }
              },
              "usageCharges": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/WorkspaceLiveCostCharge"
                }
              },
              "estimatedMonthlyFixedSar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "blockers": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/WorkspaceLiveCostBlocker"
                }
              },
              "complete": {
                "type": "boolean"
              }
            },
            "required": [
              "currency",
              "platformMonthlySar",
              "platformSetupSar",
              "liveCapableCount",
              "recurringCharges",
              "usageCharges",
              "estimatedMonthlyFixedSar",
              "blockers",
              "complete"
            ],
            "additionalProperties": false
          },
          "WorkspaceLiveCostCharge": {
            "type": "object",
            "properties": {
              "meter": {
                "type": "string",
                "enum": [
                  "account.active_month",
                  "account.created.count",
                  "financial_address.issued.count",
                  "financial_address.active_month",
                  "transfer.internal.count",
                  "transfer.internal.volume_sar",
                  "deposit.attributed.count",
                  "deposit.attributed.volume_sar",
                  "payout.external.count",
                  "payout.external.volume_sar",
                  "collection.pay_in.count",
                  "collection.pay_in.volume_sar",
                  "noun.event.count",
                  "noun.event.volume_sar",
                  "kyb.application.review",
                  "verification.kyc.basic.count",
                  "verification.kyc.standard.count",
                  "verification.kyc.investment.count",
                  "verification.kyb.count",
                  "operation.executed.count",
                  "api.read.count",
                  "billing.invoice.settlement",
                  "billing.plan.recurring_month",
                  "billing.product.activation"
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "recurring",
                  "per_event",
                  "volume_bps"
                ]
              },
              "unit": {
                "type": "string"
              },
              "amountSar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "bps": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "summary": {
                "type": "string"
              },
              "custom": {
                "type": "boolean"
              }
            },
            "required": [
              "meter",
              "kind",
              "unit",
              "amountSar",
              "bps",
              "summary",
              "custom"
            ],
            "additionalProperties": false
          },
          "WorkspaceLiveCostBlocker": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "unpriced_meters",
                  "custom_pricing"
                ]
              },
              "meters": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "account.active_month",
                    "account.created.count",
                    "financial_address.issued.count",
                    "financial_address.active_month",
                    "transfer.internal.count",
                    "transfer.internal.volume_sar",
                    "deposit.attributed.count",
                    "deposit.attributed.volume_sar",
                    "payout.external.count",
                    "payout.external.volume_sar",
                    "collection.pay_in.count",
                    "collection.pay_in.volume_sar",
                    "noun.event.count",
                    "noun.event.volume_sar",
                    "kyb.application.review",
                    "verification.kyc.basic.count",
                    "verification.kyc.standard.count",
                    "verification.kyc.investment.count",
                    "verification.kyb.count",
                    "operation.executed.count",
                    "api.read.count",
                    "billing.invoice.settlement",
                    "billing.plan.recurring_month",
                    "billing.product.activation"
                  ]
                }
              }
            },
            "required": [
              "code",
              "meters"
            ],
            "additionalProperties": false
          },
          "ProductSurfaces": {
            "type": "object",
            "properties": {
              "graphql": {
                "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductSurfaceDescriptor"
              },
              "mcp": {
                "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductSurfaceDescriptor"
              },
              "openapi": {
                "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductSurfaceDescriptor"
              },
              "sdk": {
                "$ref": "#/components/schemas/ProductRetrieveOutput/$defs/ProductSurfaceDescriptor"
              }
            },
            "required": [
              "graphql",
              "mcp",
              "openapi",
              "sdk"
            ],
            "additionalProperties": false
          },
          "ProductSurfaceDescriptor": {
            "type": "object",
            "properties": {
              "artifactType": {
                "type": "string",
                "enum": [
                  "graphql_schema",
                  "mcp",
                  "openapi_spec",
                  "sdk_kit"
                ],
                "description": "Generated or hosted product surface class"
              },
              "environment": {
                "type": "string",
                "enum": [
                  "sandbox",
                  "live"
                ]
              },
              "activationRequired": {
                "type": "boolean"
              },
              "activationState": {
                "type": "string",
                "enum": [
                  "draft",
                  "test_only",
                  "activation_requested",
                  "cr_validation",
                  "company_validation",
                  "kyb_pending",
                  "compliance_review",
                  "approved",
                  "production_active",
                  "rejected",
                  "suspended"
                ],
                "description": "Closed Product Activation lifecycle state"
              },
              "requiredAction": {
                "type": "string",
                "enum": [
                  "request_activation",
                  "activate_subscription",
                  "resolve_rejection",
                  "resolve_suspension",
                  "mint_api_key",
                  "update_payment_method",
                  "none"
                ],
                "description": "Action needed before the surface becomes usable"
              },
              "url": {
                "description": "Usable route once no action is outstanding",
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "artifactType",
              "environment",
              "activationRequired",
              "requiredAction"
            ],
            "additionalProperties": false
          }
        }
      },
      "ReceiptListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "receiptId": {
                  "type": "string",
                  "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale receipt ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "operationName": {
                  "type": "string"
                },
                "operationId": {
                  "type": "string",
                  "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale operation ID"
                },
                "status": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "receiptId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "ReceiptRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "receiptId": {
                "type": "string",
                "pattern": "^rcp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale receipt ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "operationName": {
                "type": "string"
              },
              "operationId": {
                "type": "string",
                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale operation ID"
              },
              "status": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "receiptId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "SaleSettlementAbandonOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "abandoned"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "cancelling_1"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementCollectServiceFeeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "funded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementConfirmHandoverBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "actorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Account of the party taking this action, asserted by the deciding tenant backend and checked against the instance's party bindings",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          }
        },
        "required": [
          "actorAccountId"
        ],
        "additionalProperties": false
      },
      "SaleSettlementConfirmHandoverOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "releasing_1"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "buyerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "sellerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "platformAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
            "x-hyperscale-fee-collection-port": true,
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance",
                "workspace_revenue"
              ]
            }
          },
          "price": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
          },
          "piece1Amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
          },
          "piece2Amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
          },
          "piece3Amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
          },
          "serviceFeeAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
          },
          "currency": {
            "type": "string",
            "const": "SAR",
            "description": "Settlement currency (SAR only)"
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "buyerAccountId",
          "sellerAccountId",
          "platformAccountId",
          "price",
          "piece1Amount",
          "piece2Amount",
          "piece3Amount",
          "serviceFeeAmount",
          "currency",
          "subject"
        ],
        "additionalProperties": false
      },
      "SaleSettlementCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementFundPiece1Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "funding_1"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementFundPiece2Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "funding_2"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementFundPiece3Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "funding_3"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "saleSettlementId": {
                  "type": "string",
                  "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Sale settlement instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "sale_settlement"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "funding_1",
                    "funding_2",
                    "funding_3",
                    "funded",
                    "releasing_1",
                    "releasing_2",
                    "released",
                    "cancelling_1",
                    "cancelling_2",
                    "cancelled",
                    "abandoning_2",
                    "abandoning_1",
                    "abandoned"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "buyerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "sellerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "platformAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                      "x-hyperscale-fee-collection-port": true,
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance",
                          "workspace_revenue"
                        ]
                      }
                    },
                    "price": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
                    },
                    "piece1Amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
                    },
                    "piece2Amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
                    },
                    "piece3Amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
                    },
                    "serviceFeeAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
                    },
                    "currency": {
                      "type": "string",
                      "const": "SAR",
                      "description": "Settlement currency (SAR only)"
                    }
                  },
                  "required": [
                    "buyerAccountId",
                    "sellerAccountId",
                    "platformAccountId",
                    "price",
                    "piece1Amount",
                    "piece2Amount",
                    "piece3Amount",
                    "serviceFeeAmount",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "escrowAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fundPiece1TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fundPiece2TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fundPiece3TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "serviceFeeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "releasePiece1TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "releasePiece2TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "releasePiece3TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "cancelPiece1TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundPiece2TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundPiece3TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unfundPiece3TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unfundPiece2TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unfundPiece1TransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "saleSettlementId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "SaleSettlementRefundPiece2Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "cancelling_2"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementRefundPiece3Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "cancelled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementReleasePiece2Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "releasing_2"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementReleasePiece3Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "released"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "funding_1",
              "funding_2",
              "funding_3",
              "funded",
              "releasing_1",
              "releasing_2",
              "released",
              "cancelling_1",
              "cancelling_2",
              "cancelled",
              "abandoning_2",
              "abandoning_1",
              "abandoned"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementUnfundPiece1Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "abandoned"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementUnfundPiece2Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "abandoning_1"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SaleSettlementUnfundPiece3Output": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "saleSettlementId": {
            "type": "string",
            "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Sale settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "sale_settlement"
          },
          "status": {
            "type": "string",
            "const": "abandoning_2"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Gross held amount in SAR minor units; the piece fields partition it exactly"
              },
              "piece1Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "price - piece2Amount - piece3Amount: released to the seller, returned to the buyer on cancellation"
              },
              "piece2Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Second piece of the price partition: released to the platform, returned to the buyer on cancellation"
              },
              "piece3Amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Third piece of the price partition: released to the platform, paid to the seller on cancellation"
              },
              "serviceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Buyer-side service fee charged on top at funding; never enters escrow, non-refundable"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "Settlement currency (SAR only)"
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "platformAccountId",
              "price",
              "piece1Amount",
              "piece2Amount",
              "piece3Amount",
              "serviceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "serviceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releasePiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "cancelPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece3TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece2TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unfundPiece1TransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "saleSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SandboxAccountFundInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "maxLength": 15,
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string, capped at 15 digits per call"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          }
        },
        "required": [
          "destinationAccountId",
          "amount",
          "currency"
        ],
        "additionalProperties": false
      },
      "SandboxAccountFundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "transferStatus": {
            "type": "string",
            "const": "posted"
          }
        },
        "required": [
          "transferId",
          "tenantId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "transferStatus"
        ],
        "additionalProperties": false
      },
      "SandboxCustomerAccessActivateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "entityId": {
            "type": "string",
            "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale entity ID"
          },
          "entityStatus": {
            "type": "string",
            "enum": [
              "pending",
              "verified",
              "rejected",
              "disabled"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "active",
              "suspended",
              "closed"
            ]
          },
          "kycStatus": {
            "type": "string",
            "enum": [
              "not_required",
              "pending",
              "verified",
              "rejected"
            ]
          },
          "amlStatus": {
            "type": "string",
            "enum": [
              "not_screened",
              "clear",
              "review",
              "blocked"
            ]
          },
          "trustReviewId": {
            "type": "string",
            "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review ID"
          }
        },
        "required": [
          "customerAccessId",
          "tenantId",
          "workspaceId",
          "customerId",
          "entityId",
          "entityStatus",
          "status",
          "kycStatus",
          "amlStatus"
        ],
        "additionalProperties": false
      },
      "SandboxCustomerOnboardInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "displayName": {
            "description": "Name the app shows this customer. The identity the sandbox provider attests is fixed regardless of what is passed here.",
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          }
        },
        "required": [
          "workspaceId"
        ],
        "additionalProperties": false
      },
      "SandboxCustomerOnboardOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "customerId": {
            "type": "string",
            "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Tenant-local customer ID"
          },
          "customerAccessId": {
            "type": "string",
            "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale customer access ID"
          },
          "entityId": {
            "type": "string",
            "pattern": "^ent_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale entity ID"
          },
          "entityStatus": {
            "type": "string",
            "enum": [
              "pending",
              "verified",
              "rejected",
              "disabled"
            ]
          },
          "profileId": {
            "type": "string",
            "pattern": "^ekp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale entity KYC profile ID"
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "customerId",
          "customerAccessId",
          "entityId",
          "entityStatus",
          "profileId"
        ],
        "additionalProperties": false
      },
      "SavingsCircleCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "savingsCircleId": {
            "type": "string",
            "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Savings circle instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "savings_circle"
          },
          "status": {
            "type": "string",
            "const": "completed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "memberCount": {
                "type": "integer",
                "minimum": 2,
                "maximum": 60
              },
              "contributionAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "memberCount",
              "contributionAmount",
              "currency",
              "startAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "potAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "savingsCircleId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SavingsCircleCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "memberCount": {
            "type": "integer",
            "minimum": 2,
            "maximum": 60
          },
          "contributionAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "startAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "memberCount",
          "contributionAmount",
          "currency",
          "startAt"
        ],
        "additionalProperties": false
      },
      "SavingsCircleCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "savingsCircleId": {
            "type": "string",
            "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Savings circle instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "savings_circle"
          },
          "status": {
            "type": "string",
            "const": "forming"
          },
          "fields": {
            "type": "object",
            "properties": {
              "memberCount": {
                "type": "integer",
                "minimum": 2,
                "maximum": 60
              },
              "contributionAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "memberCount",
              "contributionAmount",
              "currency",
              "startAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "potAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "savingsCircleId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SavingsCircleDisbandOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "savingsCircleId": {
            "type": "string",
            "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Savings circle instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "savings_circle"
          },
          "status": {
            "type": "string",
            "const": "disbanded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "memberCount": {
                "type": "integer",
                "minimum": 2,
                "maximum": 60
              },
              "contributionAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "memberCount",
              "contributionAmount",
              "currency",
              "startAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "potAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "savingsCircleId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SavingsCircleListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "savingsCircleId": {
                  "type": "string",
                  "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Savings circle instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "savings_circle"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "forming",
                    "active",
                    "completed",
                    "disbanded"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "memberCount": {
                      "type": "integer",
                      "minimum": 2,
                      "maximum": 60
                    },
                    "contributionAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "startAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "memberCount",
                    "contributionAmount",
                    "currency",
                    "startAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "potAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "savingsCircleId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "SavingsCircleRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "savingsCircleId": {
            "type": "string",
            "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Savings circle instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "savings_circle"
          },
          "status": {
            "type": "string",
            "enum": [
              "forming",
              "active",
              "completed",
              "disbanded"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "memberCount": {
                "type": "integer",
                "minimum": 2,
                "maximum": 60
              },
              "contributionAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "startAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "memberCount",
              "contributionAmount",
              "currency",
              "startAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "potAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "savingsCircleId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "SubjectCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "subjectId": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale subject ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "kind": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{2,80}$"
          },
          "kindVersion": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "attributes": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "declaredValue": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              }
            },
            "required": [
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "metadata": {
            "$ref": "#/components/schemas/SubjectCreateInput/$defs/Metadata"
          }
        },
        "required": [
          "workspaceId",
          "kind",
          "kindVersion",
          "attributes",
          "declaredValue"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/SubjectCreateInput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/SubjectCreateInput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SubjectCreateInput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/SubjectCreateInput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "SubjectCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "subjectId": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale subject ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "kind": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{2,80}$"
          },
          "kindVersion": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "attributes": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "declaredValue": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              }
            },
            "required": [
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "metadata": {
            "$ref": "#/components/schemas/SubjectCreateOutput/$defs/Metadata"
          }
        },
        "required": [
          "subjectId",
          "tenantId",
          "workspaceId",
          "kind",
          "kindVersion",
          "attributes",
          "declaredValue",
          "createdAt",
          "metadata"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/SubjectCreateOutput/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/SubjectCreateOutput/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SubjectCreateOutput/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/SubjectCreateOutput/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "SubjectKindListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "pattern": "^[a-z][a-z0-9_]{2,80}$"
                },
                "version": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "title": {
                  "type": "string",
                  "minLength": 1
                },
                "origin": {
                  "type": "string",
                  "enum": [
                    "platform",
                    "tenant"
                  ],
                  "description": "platform = a sealed catalog kind every tenant shares; tenant = a kind this tenant registered via subject_kind.create"
                },
                "attributes": {
                  "type": "object",
                  "propertyNames": {
                    "type": "string"
                  },
                  "additionalProperties": {},
                  "description": "JSON Schema for this kind's subject.create attributes bag"
                },
                "declaredValue": {
                  "type": "string",
                  "const": "required",
                  "description": "Every subject row states a declaredValue (amount + currency)"
                },
                "acceptedBy": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1
                  },
                  "description": "Noun ids whose create input accepts a subject of this kind"
                }
              },
              "required": [
                "kind",
                "version",
                "title",
                "origin",
                "attributes",
                "declaredValue",
                "acceptedBy"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "SubjectListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "subjectId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 180,
                  "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale subject ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "kind": {
                  "type": "string"
                },
                "kindVersion": {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                "attributes": {
                  "type": "object",
                  "propertyNames": {
                    "type": "string"
                  },
                  "additionalProperties": {}
                },
                "declaredValueAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "declaredValueCurrency": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "subjectId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "SubjectRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "subjectId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180,
                "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale subject ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "kind": {
                "type": "string"
              },
              "kindVersion": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "attributes": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              "declaredValueAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "declaredValueCurrency": {
                "type": "string"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "subjectId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "TradeSettlementAbandonOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "const": "abandoned"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TradeSettlementCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "const": "cancelled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TradeSettlementCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "sideAAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "First trade party and funder",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "sideBAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Second trade party and funder",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "platformAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Workspace revenue or customer balance account collecting trade service fees",
            "x-hyperscale-fee-collection-port": true,
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance",
                "workspace_revenue"
              ]
            }
          },
          "sideAAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Amount side A holds against the whole exchange, in SAR minor units"
          },
          "sideBAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Amount side B holds against the whole exchange, in SAR minor units"
          },
          "sideAServiceFeeAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Side A custody fee charged on top and never placed in escrow"
          },
          "sideBServiceFeeAmount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Side B custody fee charged on top and never placed in escrow"
          },
          "currency": {
            "type": "string",
            "const": "SAR",
            "description": "One currency for both trade legs and both fees"
          }
        },
        "required": [
          "workspaceId",
          "sideAAccountId",
          "sideBAccountId",
          "platformAccountId",
          "sideAAmount",
          "sideBAmount",
          "sideAServiceFeeAmount",
          "sideBServiceFeeAmount",
          "currency"
        ],
        "additionalProperties": false
      },
      "TradeSettlementCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TradeSettlementDisputeBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "actorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Account of the party taking this action, asserted by the deciding tenant backend and checked against the instance's party bindings",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          }
        },
        "required": [
          "actorAccountId"
        ],
        "additionalProperties": false
      },
      "TradeSettlementDisputeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "const": "clawed_back"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TradeSettlementFundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "const": "funded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TradeSettlementListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "tradeSettlementId": {
                  "type": "string",
                  "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Trade settlement instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "trade_settlement"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "funded",
                    "released",
                    "settled",
                    "cancelled",
                    "abandoned",
                    "clawed_back"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "sideAAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "First trade party and funder",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "sideBAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Second trade party and funder",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "platformAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Workspace revenue or customer balance account collecting trade service fees",
                      "x-hyperscale-fee-collection-port": true,
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance",
                          "workspace_revenue"
                        ]
                      }
                    },
                    "sideAAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Amount side A holds against the whole exchange, in SAR minor units"
                    },
                    "sideBAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Amount side B holds against the whole exchange, in SAR minor units"
                    },
                    "sideAServiceFeeAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Side A custody fee charged on top and never placed in escrow"
                    },
                    "sideBServiceFeeAmount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Side B custody fee charged on top and never placed in escrow"
                    },
                    "currency": {
                      "type": "string",
                      "const": "SAR",
                      "description": "One currency for both trade legs and both fees"
                    },
                    "clawbackAt": {
                      "description": "Machine-owned absolute end of the release clawback window",
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    }
                  },
                  "required": [
                    "sideAAccountId",
                    "sideBAccountId",
                    "platformAccountId",
                    "sideAAmount",
                    "sideBAmount",
                    "sideAServiceFeeAmount",
                    "sideBServiceFeeAmount",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "escrowAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideAFundingTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideBFundingTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideAServiceFeeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideBServiceFeeTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideAReleaseReservationId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideBReleaseReservationId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideAClawbackRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideBClawbackRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideACancelRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "sideBCancelRefundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "tradeSettlementId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "TradeSettlementReleaseBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "actorAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Account of the party taking this action, asserted by the deciding tenant backend and checked against the instance's party bindings",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          }
        },
        "required": [
          "actorAccountId"
        ],
        "additionalProperties": false
      },
      "TradeSettlementReleaseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "const": "released"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TradeSettlementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tradeSettlementId": {
            "type": "string",
            "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Trade settlement instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "trade_settlement"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "funded",
              "released",
              "settled",
              "cancelled",
              "abandoned",
              "clawed_back"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "sideAAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "First trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sideBAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Second trade party and funder",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "platformAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Workspace revenue or customer balance account collecting trade service fees",
                "x-hyperscale-fee-collection-port": true,
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance",
                    "workspace_revenue"
                  ]
                }
              },
              "sideAAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side A holds against the whole exchange, in SAR minor units"
              },
              "sideBAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Amount side B holds against the whole exchange, in SAR minor units"
              },
              "sideAServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side A custody fee charged on top and never placed in escrow"
              },
              "sideBServiceFeeAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Side B custody fee charged on top and never placed in escrow"
              },
              "currency": {
                "type": "string",
                "const": "SAR",
                "description": "One currency for both trade legs and both fees"
              },
              "clawbackAt": {
                "description": "Machine-owned absolute end of the release clawback window",
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "sideAAccountId",
              "sideBAccountId",
              "platformAccountId",
              "sideAAmount",
              "sideBAmount",
              "sideAServiceFeeAmount",
              "sideBServiceFeeAmount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBFundingTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBServiceFeeTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBReleaseReservationId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideAClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBClawbackRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideACancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "sideBCancelRefundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tradeSettlementId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TravelPackageCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "travel_package"
          },
          "status": {
            "type": "string",
            "const": "cancelled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "departAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "payerAccountId",
              "departAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "travelPackageId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TravelPackageCompleteOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "travel_package"
          },
          "status": {
            "type": "string",
            "const": "completed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "departAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "payerAccountId",
              "departAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "travelPackageId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TravelPackageConfirmOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "travel_package"
          },
          "status": {
            "type": "string",
            "const": "booked"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "departAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "payerAccountId",
              "departAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "travelPackageId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TravelPackageCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "payerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "departAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: traveler_party. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "payerAccountId",
          "departAt",
          "subject"
        ],
        "additionalProperties": false
      },
      "TravelPackageCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "travel_package"
          },
          "status": {
            "type": "string",
            "const": "draft"
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "departAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "payerAccountId",
              "departAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "travelPackageId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TravelPackageListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "travelPackageId": {
                  "type": "string",
                  "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Travel package instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "travel_package"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "draft",
                    "booked",
                    "completed",
                    "cancelled"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "payerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "departAt": {
                      "type": "string",
                      "format": "date-time",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "payerAccountId",
                    "departAt"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "travelPackageId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "TravelPackageRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "travelPackageId": {
            "type": "string",
            "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Travel package instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "travel_package"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "booked",
              "completed",
              "cancelled"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "payerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "departAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "payerAccountId",
              "departAt"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "travelPackageId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "TrustEvidenceAttachBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "trustRequirementId": {
            "type": "string",
            "pattern": "^vreq_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review requirement ID"
          },
          "trustReviewSubjectId": {
            "type": "string",
            "pattern": "^vsub_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review subject ID"
          },
          "kind": {
            "type": "string",
            "enum": [
              "document_upload",
              "requirement_response"
            ]
          },
          "documentReference": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "documentType": {
            "type": "string",
            "enum": [
              "commercial_registration",
              "national_address_certificate",
              "vat_certificate",
              "bank_letter",
              "passport",
              "national_id",
              "articles_of_association",
              "board_resolution",
              "proof_of_address",
              "other"
            ]
          },
          "checksum": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "checksumAlgorithm": {
            "type": "string",
            "const": "sha256"
          },
          "mimeType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "byteSize": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "filename": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "metadata": {
            "$ref": "#/components/schemas/TrustEvidenceAttachBody/$defs/Metadata"
          }
        },
        "required": [
          "kind"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/TrustEvidenceAttachBody/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/TrustEvidenceAttachBody/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TrustEvidenceAttachBody/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/TrustEvidenceAttachBody/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "TrustEvidenceAttachOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "trustEvidenceId": {
            "type": "string",
            "pattern": "^vev_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust evidence ID"
          },
          "trustReviewId": {
            "type": "string",
            "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "kind": {
            "type": "string",
            "enum": [
              "document_upload",
              "requirement_response"
            ]
          },
          "documentType": {
            "type": "string",
            "enum": [
              "commercial_registration",
              "national_address_certificate",
              "vat_certificate",
              "bank_letter",
              "passport",
              "national_id",
              "articles_of_association",
              "board_resolution",
              "proof_of_address",
              "other"
            ]
          },
          "checksum": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "checksumAlgorithm": {
            "type": "string",
            "const": "sha256"
          }
        },
        "required": [
          "trustEvidenceId",
          "trustReviewId",
          "tenantId",
          "kind"
        ],
        "additionalProperties": false
      },
      "TrustEvidenceListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "trustEvidenceId": {
                  "type": "string",
                  "pattern": "^vev_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale trust evidence ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "trustReviewId": {
                  "type": "string",
                  "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale trust review ID"
                },
                "kind": {
                  "type": "string"
                },
                "documentType": {
                  "type": "string"
                },
                "checksum": {
                  "type": "string"
                },
                "checksumAlgorithm": {
                  "type": "string"
                },
                "mimeType": {
                  "type": "string"
                },
                "byteSize": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "filename": {
                  "type": "string"
                },
                "providerReference": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "accepted",
                    "rejected",
                    "superseded"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "trustEvidenceId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "TrustEvidenceRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "trustEvidenceId": {
                "type": "string",
                "pattern": "^vev_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale trust evidence ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "trustReviewId": {
                "type": "string",
                "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale trust review ID"
              },
              "kind": {
                "type": "string"
              },
              "documentType": {
                "type": "string"
              },
              "checksum": {
                "type": "string"
              },
              "checksumAlgorithm": {
                "type": "string"
              },
              "mimeType": {
                "type": "string"
              },
              "byteSize": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              "filename": {
                "type": "string"
              },
              "providerReference": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "accepted",
                  "rejected",
                  "superseded"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "trustEvidenceId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "TrustRequirementListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "trustRequirementId": {
                  "type": "string",
                  "pattern": "^vreq_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale trust review requirement ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string"
                },
                "trustReviewId": {
                  "type": "string",
                  "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale trust review ID"
                },
                "requirementKey": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "open",
                    "satisfied",
                    "waived",
                    "rejected"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "trustRequirementId",
                "tenantId",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "TrustRequirementRespondBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "trustReviewId": {
            "type": "string",
            "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review ID"
          },
          "trustEvidenceId": {
            "type": "string",
            "pattern": "^vev_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust evidence ID"
          },
          "response": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000
          },
          "metadata": {
            "$ref": "#/components/schemas/TrustRequirementRespondBody/$defs/Metadata"
          }
        },
        "required": [
          "trustReviewId"
        ],
        "additionalProperties": false,
        "$defs": {
          "Metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "additionalProperties": {
              "$ref": "#/components/schemas/TrustRequirementRespondBody/$defs/MetadataValue"
            }
          },
          "MetadataValue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/TrustRequirementRespondBody/$defs/MetadataScalar"
              },
              {
                "maxItems": 100,
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TrustRequirementRespondBody/$defs/MetadataScalar"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/TrustRequirementRespondBody/$defs/MetadataScalar"
                }
              }
            ]
          },
          "MetadataScalar": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "TrustRequirementRespondOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "trustRequirementId": {
            "type": "string",
            "pattern": "^vreq_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review requirement ID"
          },
          "trustReviewId": {
            "type": "string",
            "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "satisfied",
              "waived",
              "rejected"
            ]
          }
        },
        "required": [
          "trustRequirementId",
          "trustReviewId",
          "tenantId",
          "status"
        ],
        "additionalProperties": false
      },
      "TrustRequirementRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "trustRequirementId": {
                "type": "string",
                "pattern": "^vreq_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale trust review requirement ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string"
              },
              "trustReviewId": {
                "type": "string",
                "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale trust review ID"
              },
              "requirementKey": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "open",
                  "satisfied",
                  "waived",
                  "rejected"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "trustRequirementId",
              "tenantId",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "TrustReviewListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "trustReviewId": {
                  "type": "string",
                  "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale trust review ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "type": {
                  "type": "string"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "draft",
                    "submitted",
                    "under_review",
                    "approved",
                    "rejected",
                    "cancelled"
                  ]
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "trustReviewId",
                "tenantId"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "TrustReviewRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "trustReviewId": {
                "type": "string",
                "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale trust review ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "type": {
                "type": "string"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "submitted",
                  "under_review",
                  "approved",
                  "rejected",
                  "cancelled"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "trustReviewId",
              "tenantId"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "TrustReviewSubmitBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "submittedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "additionalProperties": false
      },
      "TrustReviewSubmitOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "trustReviewId": {
            "type": "string",
            "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale trust review ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "submitted",
              "under_review",
              "approved",
              "rejected",
              "cancelled"
            ]
          }
        },
        "required": [
          "trustReviewId",
          "tenantId",
          "status"
        ],
        "additionalProperties": false
      },
      "UsageRecordListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "usageRecordId": {
                  "type": "string",
                  "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale usage record ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "meter": {
                  "type": "string"
                },
                "quantity": {
                  "type": "string"
                },
                "operationName": {
                  "type": "string"
                },
                "operationId": {
                  "type": "string",
                  "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale operation ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "usageRecordId",
                "tenantId",
                "meter"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "UsageRecordRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "usageRecordId": {
                "type": "string",
                "pattern": "^usg_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale usage record ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "meter": {
                "type": "string"
              },
              "quantity": {
                "type": "string"
              },
              "operationName": {
                "type": "string"
              },
              "operationId": {
                "type": "string",
                "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale operation ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "usageRecordId",
              "tenantId",
              "meter"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowCollectPenaltyOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "const": "penalty_collected"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowConfirmCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "const": "canceled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "buyerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "sellerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "policyId": {
            "type": "string",
            "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Motor policy that must be active for the escrow to clear"
          },
          "price": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "buyerAccountId",
          "sellerAccountId",
          "policyId",
          "price",
          "currency",
          "subject"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowFundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "const": "funded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "vehicleEscrowId": {
                  "type": "string",
                  "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Vehicle escrow instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "vehicle_escrow"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "funded",
                    "settled",
                    "cancel_quoted",
                    "canceled",
                    "penalty_collected"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "buyerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "sellerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "policyId": {
                      "type": "string",
                      "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Motor policy that must be active for the escrow to clear"
                    },
                    "price": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "buyerAccountId",
                    "sellerAccountId",
                    "policyId",
                    "price",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "escrowAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "fundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "releaseTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "penaltyTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindRefund": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "unwindPenalty": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "vehicleEscrowId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowQuoteCancelOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "const": "cancel_quoted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowReleaseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "const": "settled"
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "funded",
              "settled",
              "cancel_quoted",
              "canceled",
              "penalty_collected"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleEscrowUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "VehicleEscrowUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleEscrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_escrow"
          },
          "status": {
            "type": "string",
            "enum": [
              "created"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "buyerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "policyId": {
                "type": "string",
                "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Motor policy that must be active for the escrow to clear"
              },
              "price": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "buyerAccountId",
              "sellerAccountId",
              "policyId",
              "price",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "escrowAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "fundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "releaseTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "penaltyTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindRefund": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "unwindPenalty": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleEscrowId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingCompleteOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "const": "sold"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "sellerAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "headline": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "description": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "askingPrice": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "escrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow whose held funds reserve this listing"
          },
          "subject": {
            "type": "string",
            "pattern": "^sbj_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "ID of an existing subject created with subject.create; its registered kind must be one of: vehicle. Discover registered kinds and their attribute schemas with subject_kind.list."
          }
        },
        "required": [
          "workspaceId",
          "sellerAccountId",
          "headline",
          "askingPrice",
          "currency",
          "subject"
        ],
        "additionalProperties": false
      },
      "VehicleListingCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "const": "listed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingDelistOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "const": "delisted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "vehicleListingId": {
                  "type": "string",
                  "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Vehicle listing instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "vehicle_listing"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "listed",
                    "reserved",
                    "sold",
                    "delisted"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "sellerAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "headline": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "description": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    "askingPrice": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "escrowId": {
                      "type": "string",
                      "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Vehicle escrow whose held funds reserve this listing"
                    }
                  },
                  "required": [
                    "sellerAccountId",
                    "headline",
                    "askingPrice",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "subject": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "vehicleListingId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "VehicleListingReserveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "const": "reserved"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "enum": [
              "listed",
              "reserved",
              "sold",
              "delisted"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingUnreserveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "const": "listed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "VehicleListingUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "headline": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "description": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "askingPrice": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "escrowId": {
            "type": "string",
            "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle escrow whose held funds reserve this listing"
          }
        },
        "additionalProperties": false
      },
      "VehicleListingUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "vehicleListingId": {
            "type": "string",
            "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Vehicle listing instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "vehicle_listing"
          },
          "status": {
            "type": "string",
            "enum": [
              "listed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "sellerAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "headline": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "askingPrice": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "escrowId": {
                "type": "string",
                "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Vehicle escrow whose held funds reserve this listing"
              }
            },
            "required": [
              "sellerAccountId",
              "headline",
              "askingPrice",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "subject": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "vehicleListingId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletActivateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletCloseOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "closed"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "holderAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "limitAmount": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "holderAccountId",
          "currency",
          "limitAmount"
        ],
        "additionalProperties": false
      },
      "WalletCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletFreezeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "frozen"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "walletId": {
                  "type": "string",
                  "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Wallet instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "wallet"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "active",
                    "frozen",
                    "closed"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "holderAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "limitAmount": {
                      "type": "string",
                      "pattern": "^(0|[1-9][0-9]{0,17})$",
                      "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "holderAccountId",
                    "currency",
                    "limitAmount"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "walletAccountId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "topupTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "withdrawTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "walletId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "WalletRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "active",
              "frozen",
              "closed"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletSpendCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet this spend draws from"
          },
          "beneficiaryAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID",
            "x-hyperscale-reference-filter": {
              "column": "role",
              "values": [
                "customer_balance"
              ]
            }
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "required": [
          "workspaceId",
          "walletId",
          "beneficiaryAccountId",
          "amount"
        ],
        "additionalProperties": false
      },
      "WalletSpendCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletSpendId": {
            "type": "string",
            "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet spend instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet_spend"
          },
          "status": {
            "type": "string",
            "const": "created"
          },
          "fields": {
            "type": "object",
            "properties": {
              "walletId": {
                "type": "string",
                "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Wallet this spend draws from"
              },
              "walletAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "beneficiaryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "walletId",
              "walletAccountId",
              "beneficiaryAccountId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "spendTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletSpendId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletSpendListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "walletSpendId": {
                  "type": "string",
                  "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Wallet spend instance ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "nounId": {
                  "type": "string",
                  "const": "wallet_spend"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "created",
                    "posted",
                    "refunded"
                  ]
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "walletId": {
                      "type": "string",
                      "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Wallet this spend draws from"
                    },
                    "walletAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "beneficiaryAccountId": {
                      "type": "string",
                      "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                      "description": "Hyperscale account ID",
                      "x-hyperscale-reference-filter": {
                        "column": "role",
                        "values": [
                          "customer_balance"
                        ]
                      }
                    },
                    "amount": {
                      "type": "string",
                      "pattern": "^[1-9][0-9]{0,17}$",
                      "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
                    },
                    "currency": {
                      "type": "string",
                      "minLength": 3,
                      "maxLength": 3,
                      "pattern": "^[A-Z]{3}$",
                      "description": "ISO 4217 currency code"
                    },
                    "memo": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "required": [
                    "walletId",
                    "walletAccountId",
                    "beneficiaryAccountId",
                    "amount",
                    "currency"
                  ],
                  "additionalProperties": false
                },
                "refs": {
                  "type": "object",
                  "properties": {
                    "spendTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    },
                    "refundTransferId": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 180
                    }
                  },
                  "additionalProperties": false
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "walletSpendId",
                "tenantId",
                "workspaceId",
                "nounId",
                "status",
                "fields",
                "refs",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "WalletSpendPostOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletSpendId": {
            "type": "string",
            "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet spend instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet_spend"
          },
          "status": {
            "type": "string",
            "const": "posted"
          },
          "fields": {
            "type": "object",
            "properties": {
              "walletId": {
                "type": "string",
                "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Wallet this spend draws from"
              },
              "walletAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "beneficiaryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "walletId",
              "walletAccountId",
              "beneficiaryAccountId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "spendTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletSpendId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletSpendRefundOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletSpendId": {
            "type": "string",
            "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet spend instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet_spend"
          },
          "status": {
            "type": "string",
            "const": "refunded"
          },
          "fields": {
            "type": "object",
            "properties": {
              "walletId": {
                "type": "string",
                "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Wallet this spend draws from"
              },
              "walletAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "beneficiaryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "walletId",
              "walletAccountId",
              "beneficiaryAccountId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "spendTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletSpendId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletSpendRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletSpendId": {
            "type": "string",
            "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet spend instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet_spend"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "posted",
              "refunded"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "walletId": {
                "type": "string",
                "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Wallet this spend draws from"
              },
              "walletAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "beneficiaryAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]{0,17}$",
                "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "walletId",
              "walletAccountId",
              "beneficiaryAccountId",
              "amount",
              "currency"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "spendTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "refundTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletSpendId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletTopupBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "amount": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          }
        },
        "required": [
          "amount"
        ],
        "additionalProperties": false
      },
      "WalletTopupOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletUnfreezeOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "memo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 180
          }
        },
        "additionalProperties": false
      },
      "WalletUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "active"
            ]
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WalletWithdrawBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "amount": {
            "type": "string",
            "pattern": "^(0|[1-9][0-9]{0,17})$",
            "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
          }
        },
        "required": [
          "amount"
        ],
        "additionalProperties": false
      },
      "WalletWithdrawOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Wallet instance ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "nounId": {
            "type": "string",
            "const": "wallet"
          },
          "status": {
            "type": "string",
            "const": "active"
          },
          "fields": {
            "type": "object",
            "properties": {
              "holderAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID",
                "x-hyperscale-reference-filter": {
                  "column": "role",
                  "values": [
                    "customer_balance"
                  ]
                }
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              },
              "limitAmount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "memo": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "required": [
              "holderAccountId",
              "currency",
              "limitAmount"
            ],
            "additionalProperties": false
          },
          "refs": {
            "type": "object",
            "properties": {
              "walletAccountId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "topupTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              },
              "withdrawTransferId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 180
              }
            },
            "additionalProperties": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "walletId",
          "tenantId",
          "workspaceId",
          "nounId",
          "status",
          "fields",
          "refs",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WebhookDeliveryListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "webhookDeliveryId": {
                  "type": "string",
                  "pattern": "^whdel_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale outbound webhook delivery ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string",
                  "pattern": "^whdel_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale outbound webhook delivery ID"
                },
                "webhookEndpointId": {
                  "type": "string",
                  "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale outbound webhook endpoint ID"
                },
                "eventId": {
                  "type": "string",
                  "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale audit event ID"
                },
                "eventType": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                },
                "attempt": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 9007199254740991
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "exhausted",
                    "failed",
                    "pending",
                    "succeeded"
                  ]
                },
                "httpStatus": {
                  "type": "integer",
                  "minimum": 100,
                  "maximum": 599
                },
                "responseSnippet": {
                  "type": "string",
                  "maxLength": 2048
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "deliveredAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "nextAttemptAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "webhookDeliveryId",
                "tenantId",
                "id",
                "webhookEndpointId",
                "eventId",
                "eventType",
                "attempt",
                "status",
                "createdAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "WebhookDeliveryResendOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "webhookDeliveryId": {
            "type": "string",
            "pattern": "^whdel_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook delivery ID"
          },
          "eventId": {
            "type": "string",
            "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale audit event ID"
          },
          "eventType": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120,
            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
            "description": "Hyperscale audit event type emitted from an operation policy"
          },
          "attempt": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991
          },
          "status": {
            "type": "string",
            "enum": [
              "exhausted",
              "failed",
              "pending",
              "succeeded"
            ]
          },
          "httpStatus": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 100,
                "maximum": 599
              },
              {
                "type": "null"
              }
            ]
          },
          "responseSnippet": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2048
              },
              {
                "type": "null"
              }
            ]
          },
          "nextAttemptAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "deliveredAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "webhookDeliveryId",
          "eventId",
          "eventType",
          "attempt",
          "status",
          "httpStatus",
          "responseSnippet",
          "nextAttemptAt",
          "deliveredAt",
          "createdAt"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointCreateInput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^https?:\\/\\/"
          },
          "enabledEvents": {
            "minItems": 1,
            "maxItems": 100,
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "const": "*"
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                }
              ]
            }
          },
          "description": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Product whose attributed events this endpoint receives."
          },
          "entityAccountId": {
            "description": "Deliver only events naming this account, to a channel for the end customer who owns it. Omit for the Product's own webhook.",
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$"
          }
        },
        "required": [
          "url",
          "enabledEvents",
          "workspaceId"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointCreateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "url": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^https?:\\/\\/"
          },
          "status": {
            "type": "string",
            "enum": [
              "deleted",
              "disabled",
              "enabled"
            ]
          },
          "audience": {
            "type": "string",
            "enum": [
              "entity",
              "tenant"
            ]
          },
          "entityAccountId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              {
                "type": "null"
              }
            ]
          },
          "enabledEvents": {
            "minItems": 1,
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "const": "*"
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                }
              ]
            }
          },
          "secretLast4": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4
          },
          "description": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 240
              },
              {
                "type": "null"
              }
            ]
          },
          "lastDeliveryStatus": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "exhausted",
                  "failed",
                  "pending",
                  "succeeded"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "lastDeliveryAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "signingSecret": {
            "type": "string",
            "pattern": "^whsec_[A-Za-z0-9+/=]{32,128}$",
            "description": "One-time signing secret surfaced only in the first response; receipts and replays omit it"
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "workspaceId",
          "url",
          "status",
          "audience",
          "entityAccountId",
          "enabledEvents",
          "secretLast4",
          "description",
          "lastDeliveryStatus",
          "lastDeliveryAt",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointDeleteBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointDeleteOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "enum": [
              "disabled",
              "enabled"
            ]
          },
          "status": {
            "type": "string",
            "const": "deleted"
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointDisableBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointDisableOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "const": "enabled"
          },
          "status": {
            "type": "string",
            "const": "disabled"
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointEnableBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointEnableOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "previousStatus": {
            "type": "string",
            "const": "disabled"
          },
          "status": {
            "type": "string",
            "const": "enabled"
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "updatedAt",
          "reason",
          "previousStatus",
          "status"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "webhookEndpointId": {
                  "type": "string",
                  "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale outbound webhook endpoint ID"
                },
                "tenantId": {
                  "type": "string",
                  "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Organization tenant ID"
                },
                "id": {
                  "type": "string",
                  "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale outbound webhook endpoint ID"
                },
                "url": {
                  "type": "string",
                  "maxLength": 2048,
                  "pattern": "^https?:\\/\\/"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "deleted",
                    "disabled",
                    "enabled"
                  ]
                },
                "audience": {
                  "type": "string",
                  "enum": [
                    "entity",
                    "tenant"
                  ]
                },
                "entityAccountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "workspaceId": {
                  "type": "string",
                  "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale workspace ID"
                },
                "enabledEvents": {
                  "minItems": 1,
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "string",
                        "const": "*"
                      },
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120,
                        "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                        "description": "Hyperscale audit event type emitted from an operation policy"
                      }
                    ]
                  }
                },
                "secretLast4": {
                  "type": "string",
                  "minLength": 4,
                  "maxLength": 4
                },
                "description": {
                  "type": "string",
                  "maxLength": 240
                },
                "lastDeliveryStatus": {
                  "type": "string",
                  "enum": [
                    "exhausted",
                    "failed",
                    "pending",
                    "succeeded"
                  ]
                },
                "lastDeliveryAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "webhookEndpointId",
                "tenantId",
                "id",
                "url",
                "status",
                "audience",
                "enabledEvents",
                "secretLast4",
                "createdAt",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          "statusCounts": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointRecoverBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "since": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "since"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointRecoverOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "since": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "recoveredAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "enqueuedCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "eventIds": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale audit event ID"
            }
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "since",
          "recoveredAt",
          "enqueuedCount",
          "eventIds"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "webhookEndpointId": {
                "type": "string",
                "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale outbound webhook endpoint ID"
              },
              "tenantId": {
                "type": "string",
                "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Organization tenant ID"
              },
              "id": {
                "type": "string",
                "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale outbound webhook endpoint ID"
              },
              "url": {
                "type": "string",
                "maxLength": 2048,
                "pattern": "^https?:\\/\\/"
              },
              "status": {
                "type": "string",
                "enum": [
                  "deleted",
                  "disabled",
                  "enabled"
                ]
              },
              "audience": {
                "type": "string",
                "enum": [
                  "entity",
                  "tenant"
                ]
              },
              "entityAccountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "workspaceId": {
                "type": "string",
                "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale workspace ID"
              },
              "enabledEvents": {
                "minItems": 1,
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "string",
                      "const": "*"
                    },
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                      "description": "Hyperscale audit event type emitted from an operation policy"
                    }
                  ]
                }
              },
              "secretLast4": {
                "type": "string",
                "minLength": 4,
                "maxLength": 4
              },
              "description": {
                "type": "string",
                "maxLength": 240
              },
              "lastDeliveryStatus": {
                "type": "string",
                "enum": [
                  "exhausted",
                  "failed",
                  "pending",
                  "succeeded"
                ]
              },
              "lastDeliveryAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              }
            },
            "required": [
              "webhookEndpointId",
              "tenantId",
              "id",
              "url",
              "status",
              "audience",
              "enabledEvents",
              "secretLast4",
              "createdAt",
              "updatedAt"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "item"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointSecretRotateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "url": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^https?:\\/\\/"
          },
          "status": {
            "type": "string",
            "enum": [
              "deleted",
              "disabled",
              "enabled"
            ]
          },
          "audience": {
            "type": "string",
            "enum": [
              "entity",
              "tenant"
            ]
          },
          "entityAccountId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              {
                "type": "null"
              }
            ]
          },
          "enabledEvents": {
            "minItems": 1,
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "const": "*"
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                }
              ]
            }
          },
          "secretLast4": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4
          },
          "description": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 240
              },
              {
                "type": "null"
              }
            ]
          },
          "lastDeliveryStatus": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "exhausted",
                  "failed",
                  "pending",
                  "succeeded"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "lastDeliveryAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "signingSecret": {
            "type": "string",
            "pattern": "^whsec_[A-Za-z0-9+/=]{32,128}$",
            "description": "One-time replacement signing secret surfaced only in the first response; receipts and replays omit it"
          },
          "previousSecretExpiresAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "workspaceId",
          "url",
          "status",
          "audience",
          "entityAccountId",
          "enabledEvents",
          "secretLast4",
          "description",
          "lastDeliveryStatus",
          "lastDeliveryAt",
          "createdAt",
          "updatedAt",
          "previousSecretExpiresAt"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointUpdateBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "url": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^https?:\\/\\/"
          },
          "enabledEvents": {
            "minItems": 1,
            "maxItems": 100,
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "const": "*"
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                }
              ]
            }
          },
          "description": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 240
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "reason"
        ],
        "additionalProperties": false
      },
      "WebhookEndpointUpdateOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "webhookEndpointId": {
            "type": "string",
            "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale outbound webhook endpoint ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "url": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^https?:\\/\\/"
          },
          "status": {
            "type": "string",
            "enum": [
              "deleted",
              "disabled",
              "enabled"
            ]
          },
          "audience": {
            "type": "string",
            "enum": [
              "entity",
              "tenant"
            ]
          },
          "entityAccountId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              {
                "type": "null"
              }
            ]
          },
          "enabledEvents": {
            "minItems": 1,
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "const": "*"
                },
                {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
                  "description": "Hyperscale audit event type emitted from an operation policy"
                }
              ]
            }
          },
          "secretLast4": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4
          },
          "description": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 240
              },
              {
                "type": "null"
              }
            ]
          },
          "lastDeliveryStatus": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "exhausted",
                  "failed",
                  "pending",
                  "succeeded"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "lastDeliveryAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "reason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "required": [
          "tenantId",
          "webhookEndpointId",
          "workspaceId",
          "url",
          "status",
          "audience",
          "entityAccountId",
          "enabledEvents",
          "secretLast4",
          "description",
          "lastDeliveryStatus",
          "lastDeliveryAt",
          "createdAt",
          "updatedAt",
          "reason"
        ],
        "additionalProperties": false
      },
      "WorkspaceActivationRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "blueprintId": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_-]{2,80}$",
            "description": "Commercial blueprint ID"
          },
          "readiness": {
            "$ref": "#/components/schemas/WorkspaceActivationRetrieveOutput/$defs/WorkspaceActivationReadiness"
          },
          "cost": {
            "$ref": "#/components/schemas/WorkspaceActivationRetrieveOutput/$defs/WorkspaceLiveCostEstimate"
          }
        },
        "required": [
          "environment",
          "tenantId",
          "workspaceId",
          "readiness",
          "cost"
        ],
        "additionalProperties": false,
        "$defs": {
          "WorkspaceActivationReadiness": {
            "type": "object",
            "properties": {
              "live": {
                "type": "boolean"
              },
              "outstandingLiveRequirements": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "liveUnavailableCapabilities": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "organization",
                    "identity",
                    "accounts",
                    "deposits",
                    "internal_transfers",
                    "payouts",
                    "beneficiary_verification",
                    "workspaces",
                    "activity",
                    "usage",
                    "billing",
                    "webhooks",
                    "verification",
                    "cardholder",
                    "card",
                    "card_authorization",
                    "card_transaction",
                    "card_dispute",
                    "escrow_order",
                    "listing",
                    "order",
                    "policy",
                    "claim",
                    "motor_policy",
                    "vehicle_escrow",
                    "vehicle_listing",
                    "flight_booking",
                    "hotel_stay",
                    "travel_package",
                    "wallet",
                    "wallet_spend",
                    "credit_agreement",
                    "installment",
                    "exposure_arrangement",
                    "collections_case",
                    "contact_attempt",
                    "payout_run",
                    "funding_round",
                    "funding_commitment",
                    "lender_distribution",
                    "savings_circle",
                    "circle_membership",
                    "sale_settlement",
                    "trade_settlement",
                    "held_settlement"
                  ]
                }
              }
            },
            "required": [
              "live",
              "outstandingLiveRequirements",
              "liveUnavailableCapabilities"
            ],
            "additionalProperties": false
          },
          "WorkspaceLiveCostEstimate": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string",
                "const": "SAR"
              },
              "platformMonthlySar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "platformSetupSar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "liveCapableCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "recurringCharges": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WorkspaceActivationRetrieveOutput/$defs/WorkspaceLiveCostCharge"
                }
              },
              "usageCharges": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WorkspaceActivationRetrieveOutput/$defs/WorkspaceLiveCostCharge"
                }
              },
              "estimatedMonthlyFixedSar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "blockers": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WorkspaceActivationRetrieveOutput/$defs/WorkspaceLiveCostBlocker"
                }
              },
              "complete": {
                "type": "boolean"
              }
            },
            "required": [
              "currency",
              "platformMonthlySar",
              "platformSetupSar",
              "liveCapableCount",
              "recurringCharges",
              "usageCharges",
              "estimatedMonthlyFixedSar",
              "blockers",
              "complete"
            ],
            "additionalProperties": false
          },
          "WorkspaceLiveCostCharge": {
            "type": "object",
            "properties": {
              "meter": {
                "type": "string",
                "enum": [
                  "account.active_month",
                  "account.created.count",
                  "financial_address.issued.count",
                  "financial_address.active_month",
                  "transfer.internal.count",
                  "transfer.internal.volume_sar",
                  "deposit.attributed.count",
                  "deposit.attributed.volume_sar",
                  "payout.external.count",
                  "payout.external.volume_sar",
                  "collection.pay_in.count",
                  "collection.pay_in.volume_sar",
                  "noun.event.count",
                  "noun.event.volume_sar",
                  "kyb.application.review",
                  "verification.kyc.basic.count",
                  "verification.kyc.standard.count",
                  "verification.kyc.investment.count",
                  "verification.kyb.count",
                  "operation.executed.count",
                  "api.read.count",
                  "billing.invoice.settlement",
                  "billing.plan.recurring_month",
                  "billing.product.activation"
                ]
              },
              "kind": {
                "type": "string",
                "enum": [
                  "recurring",
                  "per_event",
                  "volume_bps"
                ]
              },
              "unit": {
                "type": "string"
              },
              "amountSar": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "bps": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "summary": {
                "type": "string"
              },
              "custom": {
                "type": "boolean"
              }
            },
            "required": [
              "meter",
              "kind",
              "unit",
              "amountSar",
              "bps",
              "summary",
              "custom"
            ],
            "additionalProperties": false
          },
          "WorkspaceLiveCostBlocker": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "unpriced_meters",
                  "custom_pricing"
                ]
              },
              "meters": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "account.active_month",
                    "account.created.count",
                    "financial_address.issued.count",
                    "financial_address.active_month",
                    "transfer.internal.count",
                    "transfer.internal.volume_sar",
                    "deposit.attributed.count",
                    "deposit.attributed.volume_sar",
                    "payout.external.count",
                    "payout.external.volume_sar",
                    "collection.pay_in.count",
                    "collection.pay_in.volume_sar",
                    "noun.event.count",
                    "noun.event.volume_sar",
                    "kyb.application.review",
                    "verification.kyc.basic.count",
                    "verification.kyc.standard.count",
                    "verification.kyc.investment.count",
                    "verification.kyb.count",
                    "operation.executed.count",
                    "api.read.count",
                    "billing.invoice.settlement",
                    "billing.plan.recurring_month",
                    "billing.product.activation"
                  ]
                }
              }
            },
            "required": [
              "code",
              "meters"
            ],
            "additionalProperties": false
          }
        }
      },
      "WorkspaceBalanceSheetRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "asOf": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "liabilities": {
            "$ref": "#/components/schemas/WorkspaceBalanceSheetRetrieveOutput/$defs/WorkspaceBalanceSheetSection"
          },
          "assets": {
            "$ref": "#/components/schemas/WorkspaceBalanceSheetRetrieveOutput/$defs/WorkspaceBalanceSheetSection"
          },
          "revenue": {
            "$ref": "#/components/schemas/WorkspaceBalanceSheetRetrieveOutput/$defs/WorkspaceBalanceSheetSection"
          }
        },
        "required": [
          "environment",
          "tenantId",
          "workspaceId",
          "asOf",
          "currency",
          "liabilities",
          "assets",
          "revenue"
        ],
        "additionalProperties": false,
        "$defs": {
          "WorkspaceBalanceSheetSection": {
            "type": "object",
            "properties": {
              "total": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "lines": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WorkspaceBalanceSheetRetrieveOutput/$defs/WorkspaceBalanceSheetLine"
                }
              }
            },
            "required": [
              "total",
              "lines"
            ],
            "additionalProperties": false
          },
          "WorkspaceBalanceSheetLine": {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "enum": [
                  "customer_balance",
                  "customer_investment",
                  "workspace_escrow",
                  "workspace_pool",
                  "workspace_revenue"
                ]
              },
              "accountCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "settled": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "pending": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "available": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              }
            },
            "required": [
              "role",
              "accountCount",
              "settled",
              "pending",
              "available"
            ],
            "additionalProperties": false
          }
        }
      },
      "WorkspaceEarnRateListOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "operationName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                },
                "bps": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,3}|10000)$",
                  "description": "Fee in basis points of the transfer amount (0..10000)"
                },
                "flatAmount": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]{0,17})$",
                  "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
                }
              },
              "required": [
                "operationName",
                "updatedAt"
              ],
              "additionalProperties": false
            }
          },
          "nextCursor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "required": [
          "items"
        ],
        "additionalProperties": false
      },
      "WorkspaceEarningsSettleBody": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          }
        },
        "required": [
          "amount",
          "currency"
        ],
        "additionalProperties": false
      },
      "WorkspaceEarningsSettleOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "transferId": {
            "type": "string",
            "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale transfer ID"
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "sourceAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "destinationAccountId": {
            "type": "string",
            "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale account ID"
          },
          "amount": {
            "type": "string",
            "pattern": "^[1-9][0-9]{0,17}$",
            "description": "Positive minor-unit integer amount serialized as a string (at most 18 digits)"
          },
          "currency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "ISO 4217 currency code"
          },
          "transferStatus": {
            "type": "string",
            "const": "posted"
          }
        },
        "required": [
          "transferId",
          "tenantId",
          "workspaceId",
          "sourceAccountId",
          "destinationAccountId",
          "amount",
          "currency",
          "transferStatus"
        ],
        "additionalProperties": false
      },
      "WorkspaceGuidanceRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkspaceGuidanceRetrieveOutput/$defs/WorkspaceGuidanceItem"
            }
          },
          "nextPredicate": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "mint_api_key",
                  "make_first_call",
                  "resolve_unpriced_meters",
                  "contact_sales_custom_pricing",
                  "complete_live_requirement",
                  "promote_product"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items",
          "nextPredicate"
        ],
        "additionalProperties": false,
        "$defs": {
          "WorkspaceGuidanceItem": {
            "type": "object",
            "properties": {
              "predicate": {
                "type": "string",
                "enum": [
                  "mint_api_key",
                  "make_first_call",
                  "resolve_unpriced_meters",
                  "contact_sales_custom_pricing",
                  "complete_live_requirement",
                  "promote_product"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "satisfied",
                  "actionable",
                  "blocked"
                ]
              },
              "title": {
                "type": "string",
                "minLength": 1
              },
              "detail": {
                "type": "string",
                "minLength": 1
              },
              "target": {
                "$ref": "#/components/schemas/WorkspaceGuidanceRetrieveOutput/$defs/WorkspaceGuidanceTarget"
              },
              "requirement": {
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "predicate",
              "status",
              "title",
              "detail",
              "target"
            ],
            "additionalProperties": false
          },
          "WorkspaceGuidanceTarget": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "operation",
                  "view"
                ]
              },
              "ref": {
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "kind",
              "ref"
            ],
            "additionalProperties": false
          }
        }
      },
      "WorkspaceMarginRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "asOf": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "operationName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120,
                  "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
                },
                "sell": {
                  "type": "object",
                  "properties": {
                    "bps": {
                      "type": "string",
                      "pattern": "^-?[0-9]+(\\.[0-9]+)?$"
                    },
                    "flatAmount": {
                      "type": "string",
                      "pattern": "^-?[0-9]+(\\.[0-9]+)?$"
                    }
                  },
                  "additionalProperties": false,
                  "description": "The tenant's configured earn rate on this operation."
                },
                "buy": {
                  "type": "object",
                  "properties": {
                    "volumeBps": {
                      "type": "string",
                      "pattern": "^-?[0-9]+(\\.[0-9]+)?$"
                    },
                    "perEvent": {
                      "type": "string",
                      "pattern": "^-?[0-9]+(\\.[0-9]+)?$"
                    }
                  },
                  "additionalProperties": false,
                  "description": "What the product's frozen plan rate card charges for this operation's meters."
                },
                "net": {
                  "type": "object",
                  "properties": {
                    "bps": {
                      "type": "string",
                      "pattern": "^-?[0-9]+(\\.[0-9]+)?$"
                    },
                    "perEvent": {
                      "type": "string",
                      "pattern": "^-?[0-9]+(\\.[0-9]+)?$"
                    }
                  },
                  "required": [
                    "bps",
                    "perEvent"
                  ],
                  "additionalProperties": false,
                  "description": "Sell minus buy on each axis; negative when the earn rate does not cover the plan rate."
                }
              },
              "required": [
                "operationName",
                "sell",
                "buy",
                "net"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "asOf",
          "items"
        ],
        "additionalProperties": false
      },
      "WorkspaceOperationSetRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "legacy",
              "frozen"
            ]
          },
          "workspaceBuildId": {
            "type": "string",
            "pattern": "^wbld_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace build ID"
          },
          "tenantSurfaceVersion": {
            "type": "number",
            "const": 2
          },
          "tenantOperationSetDigest": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$",
            "description": "SHA-256 of the canonical frozen public verb set"
          },
          "publicVerbs": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkspaceOperationSetRetrieveOutput/$defs/WorkspacePublicVerb"
            }
          }
        },
        "required": [
          "status",
          "workspaceBuildId"
        ],
        "additionalProperties": false,
        "$defs": {
          "WorkspacePublicVerb": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "pattern": "^[a-z][A-Za-z0-9]*$",
                "description": "Author-approved camelCase domain verb name"
              },
              "noun": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]*$",
                "description": "Stable domain noun id"
              },
              "inputSchema": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/WorkspaceOperationSetRetrieveOutput/$defs/__schema0"
                }
              },
              "outputSchema": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/WorkspaceOperationSetRetrieveOutput/$defs/__schema0"
                }
              },
              "actorPolicy": {
                "type": "object",
                "properties": {
                  "principal": {
                    "type": "string",
                    "enum": [
                      "api_key",
                      "customer_session",
                      "user_session"
                    ]
                  }
                },
                "required": [
                  "principal"
                ],
                "additionalProperties": false
              },
              "portPolicy": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "const": "none"
                      }
                    },
                    "required": [
                      "kind"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "const": "tenant_decision"
                      },
                      "allowedParties": {
                        "minItems": 1,
                        "type": "array",
                        "items": {
                          "type": "string",
                          "enum": [
                            "payer",
                            "beneficiary",
                            "subjectHolder"
                          ]
                        }
                      }
                    },
                    "required": [
                      "kind",
                      "allowedParties"
                    ],
                    "additionalProperties": false
                  }
                ]
              },
              "idempotencyPolicy": {
                "type": "object",
                "properties": {
                  "mode": {
                    "type": "string",
                    "enum": [
                      "not_required",
                      "optional",
                      "required"
                    ]
                  }
                },
                "required": [
                  "mode"
                ],
                "additionalProperties": false
              },
              "receiptPolicy": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "minLength": 1
                  },
                  "includeEvidence": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "type",
                  "includeEvidence"
                ],
                "additionalProperties": false
              },
              "receiptEvidence": {
                "type": "object",
                "properties": {
                  "required": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "ledger",
                        "local",
                        "external"
                      ]
                    }
                  },
                  "optional": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "ledger",
                        "local",
                        "external"
                      ]
                    }
                  }
                },
                "required": [
                  "required"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "name",
              "noun",
              "inputSchema",
              "outputSchema",
              "actorPolicy",
              "portPolicy",
              "idempotencyPolicy",
              "receiptPolicy",
              "receiptEvidence"
            ],
            "additionalProperties": false
          },
          "__schema0": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              },
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WorkspaceOperationSetRetrieveOutput/$defs/__schema0"
                }
              },
              {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "$ref": "#/components/schemas/WorkspaceOperationSetRetrieveOutput/$defs/__schema0"
                }
              }
            ]
          }
        }
      },
      "WorkspaceTreasuryProvisionOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "treasuryStatus": {
            "type": "string",
            "enum": [
              "provisioned",
              "existing"
            ]
          },
          "accounts": {
            "minItems": 2,
            "maxItems": 2,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "accountId": {
                  "type": "string",
                  "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                  "description": "Hyperscale account ID"
                },
                "role": {
                  "type": "string",
                  "enum": [
                    "workspace_credit",
                    "workspace_revenue"
                  ]
                },
                "currency": {
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 3,
                  "pattern": "^[A-Z]{3}$",
                  "description": "ISO 4217 currency code"
                }
              },
              "required": [
                "accountId",
                "role",
                "currency"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "tenantId",
          "workspaceId",
          "treasuryStatus",
          "accounts"
        ],
        "additionalProperties": false
      },
      "WorkspaceTreasuryRetrieveOutput": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "environment": {
            "type": "string",
            "enum": [
              "sandbox",
              "live"
            ]
          },
          "tenantId": {
            "type": "string",
            "pattern": "^ten_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Organization tenant ID"
          },
          "workspaceId": {
            "type": "string",
            "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
            "description": "Hyperscale workspace ID"
          },
          "asOf": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
          },
          "credit": {
            "type": "object",
            "properties": {
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "available": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "pending": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "settled": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              }
            },
            "required": [
              "accountId",
              "available",
              "pending",
              "settled",
              "currency"
            ],
            "additionalProperties": false
          },
          "revenue": {
            "type": "object",
            "properties": {
              "accountId": {
                "type": "string",
                "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
                "description": "Hyperscale account ID"
              },
              "available": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "pending": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "settled": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]{0,17})$",
                "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
              },
              "currency": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3,
                "pattern": "^[A-Z]{3}$",
                "description": "ISO 4217 currency code"
              }
            },
            "required": [
              "accountId",
              "available",
              "pending",
              "settled",
              "currency"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "environment",
          "tenantId",
          "workspaceId",
          "asOf",
          "credit",
          "revenue"
        ],
        "additionalProperties": false
      }
    },
    "parameters": {
      "HyperscaleEnvironment": {
        "name": "X-Hyperscale-Environment",
        "in": "header",
        "description": "Selects the Hyperscale environment for this request; omitted requests run in sandbox.",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "sandbox",
            "live"
          ]
        }
      },
      "RequestId": {
        "name": "X-Request-Id",
        "in": "header",
        "description": "Optional client correlation ID; Hyperscale echoes it as x-request-id or generates one when omitted.",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "IdempotencyKey": {
        "name": "Idempotency-Key",
        "in": "header",
        "description": "Required replay key for mutations; repeat the same key and request to receive the original terminal result.",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "securitySchemes": {
      "HyperscaleWebhookSignature": {
        "type": "apiKey",
        "in": "header",
        "name": "webhook-signature",
        "description": "HMAC-SHA256 signature for Hyperscale outbound webhook deliveries. Verify it with the webhook-id and webhook-timestamp headers over `webhook-id.webhook-timestamp.<raw-body>` using the endpoint signing secret."
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "Hyperscale bearer token (hyperscale_… API key or hyperscale_sess_… portal session)",
        "description": "Bearer credential sent as `Authorization: Bearer <token>`. Supply ONE of two token types depending on the caller:\n\n- Product API key (`hyperscale_…`) for server-side SDK, REST, and MCP calls. Request access at https://hyperscale0.ai/request-access. Select the environment per request with the `X-Hyperscale-Environment` header.\n- Portal session token (`hyperscale_sess_…`) for browser flows, issued by portal sign-in and refreshed through the portal session flow.\n\nOperator/system endpoints authenticate with `SystemKeyAuth` instead."
      },
      "CustomerSessionAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "Hyperscale end-customer session token (hyperscale_cust_…)",
        "description": "End-customer session credential sent as `Authorization: Bearer hyperscale_cust_...`, issued by customer signup and customer login. It authenticates a shopper of one Product, never the company's own staff or servers. Staff and servers use `BearerAuth`. The session is bound to the Product it was minted for and acts only on rows that customer owns."
      }
    }
  },
  "paths": {
    "/v1/accounts": {
      "post": {
        "operationId": "account_create",
        "tags": [
          "account"
        ],
        "summary": "Create an account",
        "description": "Provisions a public ledger-backed account for a tenant, customer, or workspace owner with a fixed currency and role. Noun-owned escrow is not a public account role and is provisioned only by the sealed noun kernel. A workspace's credit/revenue treasury pair is provisioned separately during workspace setup. The currency, role, and normal balance are set at creation and cannot be changed afterward. An optional balanceCapMinor sets a maximum balance in the account's own currency minor units; a deposit that would push the account over this cap is rejected and returned to the sender.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "account:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "account"
          },
          "metering": {
            "meter": "account.created.count",
            "meters": [
              "account.created.count",
              "account.active_month"
            ]
          },
          "audit": {
            "event": "account.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create an account",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account",
          "resourceRef": "account",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "account.created",
            "operation": "account.create",
            "operationId": "account_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/AccountCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountCreate({\n  body: {\n    owner: {\n      type: \"customer\",\n      id: \"cus_sandbox_aisha0001\",\n    },\n    role: \"customer_balance\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "account_role_owner_mismatch",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "owner_unsupported",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountCreateInput"
              },
              "examples": {
                "customer_balance_account": {
                  "value": {
                    "owner": {
                      "type": "customer",
                      "id": "cus_sandbox_aisha0001"
                    },
                    "role": "customer_balance",
                    "currency": "SAR"
                  }
                },
                "default": {
                  "value": {
                    "owner": {
                      "type": "customer",
                      "id": "cus_sandbox_aisha0001"
                    },
                    "role": "customer_balance",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "accountId": "acct_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "owner": {
                        "type": "tenant",
                        "id": "ten_sandbox_example0001"
                      },
                      "role": "tenant_billing",
                      "currency": "SAR",
                      "normalBalance": "debit",
                      "status": "open"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, account_role_owner_mismatch, currency_mismatch, owner_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "account_role_owner_mismatch",
              "currency_mismatch",
              "owner_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "account_list",
        "tags": [
          "account"
        ],
        "summary": "List Accounts",
        "description": "List Accounts as a cursor-paginated page. A Hyperscale Account: a first-party, ledger-backed balance held for a platform, Product, entity, customer, escrow, settlement, or suspense purpose. It is never an external bank account; external payability comes from a financial address attached to it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Accounts",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account",
          "resourceRef": "account",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "role",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "tenant_billing",
                "tenant_credit",
                "tenant_settlement",
                "tenant_master_mirror",
                "customer_balance",
                "customer_investment",
                "workspace_escrow",
                "workspace_pool",
                "workspace_credit",
                "workspace_revenue",
                "platform_estate_mirror",
                "platform_revenue",
                "provider_payable",
                "platform_reserve",
                "platform_suspense"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "open",
                "frozen",
                "closed"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    role: \"tenant_billing\",\n    status: \"pending\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}": {
      "get": {
        "operationId": "account_retrieve",
        "tags": [
          "account"
        ],
        "summary": "Retrieve an Account",
        "description": "Retrieve a single Account by its accountId. A Hyperscale Account: a first-party, ledger-backed balance held for a platform, Product, entity, customer, escrow, settlement, or suspense purpose. It is never an external bank account; external payability comes from a financial address attached to it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an Account",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account",
          "resourceRef": "account",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountRetrieve({\n  path: {\n    accountId: \"acct_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "accountId": "acct_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}/balance": {
      "get": {
        "operationId": "account_balance_retrieve",
        "tags": [
          "account"
        ],
        "summary": "Retrieve an account balance",
        "description": "Reads the account's live posted and pending counters from the ledger and returns settled and available balances without persisting balance truth outside the ledger.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.balance.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [
          "ledger_read"
        ],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.balance.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an account balance",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account balance",
          "resourceRef": "account",
          "viewId": "account_balance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountBalanceRetrieve({\n  path: {\n    accountId: \"acct_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_dangling",
          "account_ledger_unprovisioned",
          "invalid_credentials",
          "ledger_unavailable",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountBalanceRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "accountId": "acct_sandbox_example0001",
                      "asOf": "2026-01-01T00:00:00.000Z",
                      "available": "1",
                      "creditsPending": "1",
                      "creditsPosted": "1",
                      "currency": "SAR",
                      "debitsPending": "1",
                      "debitsPosted": "1",
                      "environment": "sandbox",
                      "normalBalance": "debit",
                      "pending": "1",
                      "settled": "1",
                      "tenantId": "ten_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_dangling, account_ledger_unprovisioned.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_dangling",
              "account_ledger_unprovisioned"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}/close": {
      "post": {
        "operationId": "account_close",
        "tags": [
          "account"
        ],
        "summary": "Close an account",
        "description": "Moves an open or frozen account to closed status only after the ledger reports zero posted balance and no pending debit or credit holds. Closing over a system-plane freeze is refused the same way tenant unfreeze is.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger_read"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "write",
              "tenantScoped": true,
              "idPath": "accountId",
              "status": {
                "allowed": [
                  "open",
                  "frozen"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "account.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Close an account",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account close",
          "resourceRef": "account",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "account.closed",
            "operation": "account.close",
            "operationId": "account_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/AccountCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountClose({\n  path: {\n    accountId: \"acct_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_close_balance_nonzero",
          "account_freeze_plane_forbidden",
          "account_not_found",
          "account_status_forbidden",
          "invalid_credentials",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountCloseBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "accountId": "acct_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "open",
                      "status": "closed"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_close_balance_nonzero, account_freeze_plane_forbidden, account_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_close_balance_nonzero",
              "account_freeze_plane_forbidden",
              "account_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}/freeze": {
      "post": {
        "operationId": "account_freeze",
        "tags": [
          "account"
        ],
        "summary": "Freeze an account",
        "description": "Moves an open account to frozen status without mutating ledger balances, holds, or internal transfers. While frozen, transfer legs that debit the account always refuse; credits refuse per the freeze reason class. Tenant freezes cannot be lifted over a system-plane freeze.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.freeze",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.frozen",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "write",
              "tenantScoped": true,
              "idPath": "accountId",
              "status": {
                "allowed": [
                  "open"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "account.frozen"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Freeze an account",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account freeze",
          "resourceRef": "account",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "account.frozen",
            "operation": "account.freeze",
            "operationId": "account_freeze",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/AccountFreezeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountFreeze({\n  path: {\n    accountId: \"acct_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n    reasonClass: \"customer_request\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "account_status_forbidden",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountFreezeBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change.",
                    "reasonClass": "customer_request"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountFreezeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "accountId": "acct_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "reasonClass": "customer_request",
                      "previousStatus": "open",
                      "status": "frozen"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}/statements/{period}": {
      "get": {
        "operationId": "account_statement_retrieve",
        "tags": [
          "account"
        ],
        "summary": "Retrieve a monthly account statement",
        "description": "Derives one UTC calendar month's opening balance, immutable receipt-linked ledger lines, running balances, and closing balance directly from the ledger's own history. Refuses the statement if any line lacks exact terminal evidence, if the deltas do not reconcile, or if the month exceeds 50,000 lines.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.statement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [
          "ledger_read"
        ],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.statement.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            },
            {
              "kind": "internal_transfer",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a monthly account statement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account statement",
          "resourceRef": "account",
          "viewId": "account_statement",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID"
            }
          },
          {
            "name": "period",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(?:19(?:7[0-9]|[89][0-9])|[2-9][0-9]{3})-(0[1-9]|1[0-2])$",
              "description": "UTC calendar month in YYYY-MM form"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountStatementRetrieve({\n  path: {\n    accountId: \"acct_sandbox_example0001\",\n    period: \"2026-01\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_unprovisioned",
          "invalid_credentials",
          "ledger_unavailable",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked",
          "statement_evidence_incomplete",
          "statement_evidence_mismatch",
          "statement_line_limit_exceeded"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountStatementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "accountId": "acct_sandbox_example0001",
                      "closingBalance": "1",
                      "currency": "SAR",
                      "environment": "sandbox",
                      "finalized": true,
                      "openingBalance": "1",
                      "period": "2026-01",
                      "periodEndExclusive": "2026-02-01T00:00:00.000Z",
                      "periodStart": "2026-01-01T00:00:00.000Z",
                      "tenantId": "ten_sandbox_example0001",
                      "lines": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_unprovisioned, statement_evidence_incomplete, statement_evidence_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_unprovisioned",
              "statement_evidence_incomplete",
              "statement_evidence_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "Contract-declared domain errors: request_body_too_large, statement_line_limit_exceeded.",
            "x-hyperscale-error-codes": [
              "request_body_too_large",
              "statement_line_limit_exceeded"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}/statements/{period}/export": {
      "get": {
        "operationId": "account_statement_export",
        "tags": [
          "account"
        ],
        "summary": "Export a monthly account statement",
        "description": "Exports the same immutable receipt-linked UTC monthly statement truth as deterministic formula-safe RFC 4180 CSV, including exact period boundaries, opening and closing balances, signed deltas, human memos, counterparties, and originating operation or noun linkage.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.statement.export",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [
          "ledger_read"
        ],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.statement.exported",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            },
            {
              "kind": "internal_transfer",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Export a monthly account statement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account statement export",
          "resourceRef": "account",
          "viewId": "account_statement",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID"
            }
          },
          {
            "name": "period",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(?:19(?:7[0-9]|[89][0-9])|[2-9][0-9]{3})-(0[1-9]|1[0-2])$",
              "description": "UTC calendar month in YYYY-MM form"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountStatementExport({\n  path: {\n    accountId: \"acct_sandbox_statement0001\",\n    period: \"2026-07\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_unprovisioned",
          "invalid_credentials",
          "ledger_unavailable",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked",
          "statement_evidence_incomplete",
          "statement_evidence_mismatch",
          "statement_line_limit_exceeded"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountStatementExportOutput"
                },
                "examples": {
                  "monthly-csv": {
                    "value": {
                      "accountId": "acct_sandbox_statement0001",
                      "closingBalance": "600",
                      "contentType": "text/csv",
                      "csv": "period,period_start,period_end_exclusive,opening_balance,closing_balance,entry_id,occurred_at,direction,amount,balance_delta,running_balance,currency,status,memo,counterparty_account_id,counterparty_display_name,operation_id,operation_name,noun_id,noun_instance_id,verb,transfer_id\r\n2026-07,2026-07-01T00:00:00.000Z,2026-08-01T00:00:00.000Z,1000,600,stln_sandbox_statement0001,2026-07-10T09:00:00.000Z,debit,400,-400,600,SAR,posted,sale_settlement sale_sandbox_statement0001 · release_piece_2,acct_sandbox_counterparty0001,ComicDen escrow,ops_sandbox_statement0001,sale_settlement.release_piece_2,sale_settlement,sale_sandbox_statement0001,release_piece_2,trn_sandbox_statement0001\r\n",
                      "currency": "SAR",
                      "environment": "sandbox",
                      "filename": "acct_sandbox_statement0001-2026-07.csv",
                      "finalized": true,
                      "openingBalance": "1000",
                      "period": "2026-07",
                      "periodEndExclusive": "2026-08-01T00:00:00.000Z",
                      "periodStart": "2026-07-01T00:00:00.000Z",
                      "sha256": "00940f93a982dd021c011854b4796b8aacf695b4de3a6d04d01db0ff78548896",
                      "sizeBytes": 684,
                      "tenantId": "ten_sandbox_statement0001"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_unprovisioned, statement_evidence_incomplete, statement_evidence_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_unprovisioned",
              "statement_evidence_incomplete",
              "statement_evidence_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "Contract-declared domain errors: request_body_too_large, statement_line_limit_exceeded.",
            "x-hyperscale-error-codes": [
              "request_body_too_large",
              "statement_line_limit_exceeded"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/accounts/{accountId}/unfreeze": {
      "post": {
        "operationId": "account_unfreeze",
        "tags": [
          "account"
        ],
        "summary": "Unfreeze an account",
        "description": "Restores a frozen account to open status without mutating ledger balances, holds, or internal transfers. Refused when the freeze was imposed on the system plane; only the platform can lift those.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "account.unfreeze",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "account.unfrozen",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "account",
              "action": "write",
              "tenantScoped": true,
              "idPath": "accountId",
              "status": {
                "allowed": [
                  "frozen"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "account.unfrozen"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Unfreeze an account",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Account unfreeze",
          "resourceRef": "account",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "account.unfrozen",
            "operation": "account.unfreeze",
            "operationId": "account_unfreeze",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/AccountUnfreezeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.accountUnfreeze({\n  path: {\n    accountId: \"acct_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_freeze_plane_forbidden",
          "account_not_found",
          "account_status_forbidden",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountUnfreezeBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountUnfreezeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "accountId": "acct_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "frozen",
                      "status": "open"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_freeze_plane_forbidden, account_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_freeze_plane_forbidden",
              "account_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/activity": {
      "get": {
        "operationId": "activity_list",
        "tags": [
          "activity"
        ],
        "summary": "List tenant activity",
        "description": "List tenant activity",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "activity.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "operation:read",
          "receipt:read",
          "audit:read",
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "activity.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "operation",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "receipt",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "audit",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "usage",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List tenant activity",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Activity"
          ],
          "publicNoun": "Activity",
          "viewId": "activity",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "operation",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "accepted",
                "pending",
                "succeeded",
                "failed"
              ]
            }
          },
          {
            "name": "resourceKind",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "account",
                "financial_address",
                "api_key",
                "audit",
                "workspace_capability",
                "charge",
                "collection",
                "consent",
                "credit_balance",
                "credit_grant",
                "credit_ledger_entry",
                "credit_note",
                "credit_note_line",
                "customer",
                "beneficiary",
                "deposit",
                "entity",
                "entity_kyc_profile",
                "expected_payment",
                "noun_instance",
                "operation",
                "payout",
                "beneficiary_verification",
                "workspace",
                "customer_access",
                "customer_session",
                "external_confirmation",
                "provider_cost_event",
                "provider_webhook_event",
                "webhook_endpoint",
                "webhook_delivery",
                "receipt",
                "tenant",
                "subject",
                "subject_kind",
                "statement_line",
                "reconciliation_run",
                "reconciliation_break",
                "reporting_artifact",
                "str_case",
                "wedged_money_repair",
                "reconciliation_break_repair",
                "attribution_queue",
                "user_session",
                "internal_transfer",
                "usage",
                "billing_adjustment",
                "meter_rate_discount",
                "platform_alert",
                "platform_rate_override",
                "billing_period",
                "billing_subscription",
                "invoice",
                "invoice_line",
                "meter_period_snapshot",
                "trust_review",
                "trust_evidence",
                "trust_requirement",
                "trust_review_subject",
                "support_ticket",
                "support_ticket_message",
                "support_booking",
                "support_plan_selection",
                "tenant_bank_connection",
                "team",
                "team_membership",
                "user"
              ]
            }
          },
          {
            "name": "resourceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.activityList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    operation: \"account.create\",\n    status: \"accepted\",\n    resourceKind: \"account\",\n    resourceId: \"resource_sandbox_example0001\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActivityListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/beneficiaries": {
      "post": {
        "operationId": "beneficiary_create",
        "tags": [
          "beneficiary"
        ],
        "summary": "Create a beneficiary",
        "description": "Create a beneficiary",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "beneficiary.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "beneficiary.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "beneficiary",
              "action": "create",
              "tenantScoped": true,
              "apiKeyAccess": "shared_tenant",
              "productBinding": "shared_tenant"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "beneficiary.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a beneficiary",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Beneficiaries"
          ],
          "publicNoun": "Beneficiary",
          "resourceRef": "beneficiary",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payouts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "beneficiary.created",
            "operation": "beneficiary.create",
            "operationId": "beneficiary_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/BeneficiaryCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.beneficiaryCreate({\n  body: {\n    name: \"Sara Al Otaibi\",\n    accountAddress: \"SA8080000000608010167519\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "beneficiary_id_reserved",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BeneficiaryCreateInput"
              },
              "examples": {
                "create_seller_beneficiary": {
                  "value": {
                    "name": "Sara Al Otaibi",
                    "accountAddress": "SA8080000000608010167519"
                  }
                },
                "default": {
                  "value": {
                    "name": "Sara Al Otaibi",
                    "accountAddress": "SA8080000000608010167519"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BeneficiaryCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "beneficiaryId": "ben_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "name": "Sandbox account",
                      "accountAddress": "SA0380000000608010167519",
                      "status": "pending",
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "metadata": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, beneficiary_id_reserved, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "beneficiary_id_reserved",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "beneficiary_list",
        "tags": [
          "beneficiary"
        ],
        "summary": "List Beneficiaries",
        "description": "List Beneficiaries as a cursor-paginated page. A verified external payee money can leave to. Payouts and withdrawals refuse a beneficiary that is unverified or inactive, and verification records a confirmation-of-payee match grade.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "beneficiary.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "beneficiary:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "beneficiary.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "beneficiary",
              "action": "read",
              "tenantScoped": true,
              "apiKeyAccess": "shared_tenant",
              "productBinding": "shared_tenant"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Beneficiaries",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Beneficiaries"
          ],
          "publicNoun": "Beneficiary",
          "resourceRef": "beneficiary",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payouts"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "active",
                "disabled"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.beneficiaryList({\n  query: {\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"pending\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BeneficiaryListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/beneficiaries/{beneficiaryId}": {
      "get": {
        "operationId": "beneficiary_retrieve",
        "tags": [
          "beneficiary"
        ],
        "summary": "Retrieve a Beneficiary",
        "description": "Retrieve a single Beneficiary by its beneficiaryId. A verified external payee money can leave to. Payouts and withdrawals refuse a beneficiary that is unverified or inactive, and verification records a confirmation-of-payee match grade.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "beneficiary.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "beneficiary:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "beneficiary.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "beneficiary",
              "action": "read",
              "tenantScoped": true,
              "idPath": "beneficiaryId",
              "apiKeyAccess": "shared_tenant",
              "productBinding": "shared_tenant"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Beneficiary",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Beneficiaries"
          ],
          "publicNoun": "Beneficiary",
          "resourceRef": "beneficiary",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payouts"
        ],
        "parameters": [
          {
            "name": "beneficiaryId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.beneficiaryRetrieve({\n  path: {\n    beneficiaryId: \"resource_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BeneficiaryRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "beneficiaryId": "ben_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/billing-adjustments": {
      "get": {
        "operationId": "billing_adjustment_list",
        "tags": [
          "billing_adjustment"
        ],
        "summary": "List Billing adjustments",
        "description": "List Billing adjustments as a cursor-paginated page. A credit or debit applied to a billing period outside normal metering: a goodwill credit, a correction, or a manual charge, carrying its own direction, amount, and approval state.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "billing_adjustment.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "billing_adjustment.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "billing_adjustment",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Billing adjustments",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Billing periods"
          ],
          "publicNoun": "Billing adjustment",
          "resourceRef": "billing_adjustment",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "draft",
                "applied",
                "voided"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.billingAdjustmentList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"draft\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingAdjustmentListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/billing-adjustments/{billingAdjustmentId}": {
      "get": {
        "operationId": "billing_adjustment_retrieve",
        "tags": [
          "billing_adjustment"
        ],
        "summary": "Retrieve a Billing adjustment",
        "description": "Retrieve a single Billing adjustment by its billingAdjustmentId. A credit or debit applied to a billing period outside normal metering: a goodwill credit, a correction, or a manual charge, carrying its own direction, amount, and approval state.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "billing_adjustment.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "billing_adjustment.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "billing_adjustment",
              "action": "read",
              "tenantScoped": true,
              "idPath": "billingAdjustmentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Billing adjustment",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Billing periods"
          ],
          "publicNoun": "Billing adjustment",
          "resourceRef": "billing_adjustment",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "billingAdjustmentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.billingAdjustmentRetrieve({\n  path: {\n    billingAdjustmentId: \"badj_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingAdjustmentRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "billingAdjustmentId": "badj_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/billing-periods": {
      "get": {
        "operationId": "billing_period_list",
        "tags": [
          "billing_period"
        ],
        "summary": "List Billing periods",
        "description": "List Billing periods as a cursor-paginated page. The billing window a Product's usage, charges, and invoice belong to. A period opens, accrues, then closes for invoicing; nothing is billed outside a period.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "billing_period.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "billing_period.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "billing_period",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Billing periods",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Billing periods"
          ],
          "publicNoun": "Billing period",
          "resourceRef": "billing_period",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "open",
                "snapshotted",
                "finalized",
                "voided"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.billingPeriodList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"open\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingPeriodListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/billing-periods/{billingPeriodId}": {
      "get": {
        "operationId": "billing_period_retrieve",
        "tags": [
          "billing_period"
        ],
        "summary": "Retrieve a Billing period",
        "description": "Retrieve a single Billing period by its billingPeriodId. The billing window a Product's usage, charges, and invoice belong to. A period opens, accrues, then closes for invoicing; nothing is billed outside a period.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "billing_period.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "billing_period.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "billing_period",
              "action": "read",
              "tenantScoped": true,
              "idPath": "billingPeriodId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Billing period",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Billing periods"
          ],
          "publicNoun": "Billing period",
          "resourceRef": "billing_period",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "billingPeriodId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.billingPeriodRetrieve({\n  path: {\n    billingPeriodId: \"bper_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingPeriodRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "billingPeriodId": "bper_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/billing-subscriptions": {
      "get": {
        "operationId": "billing_subscription_list",
        "tags": [
          "billing_subscription"
        ],
        "summary": "List Billing subscriptions",
        "description": "List Billing subscriptions as a cursor-paginated page. A Product's subscription inside one billing period: the plan it runs on, when it started, and when it was cancelled.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "billing_subscription.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "billing_subscription.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "billing_subscription",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Billing subscriptions",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Billing periods"
          ],
          "publicNoun": "Billing subscription",
          "resourceRef": "billing_subscription",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.billingSubscriptionList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingSubscriptionListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/billing-subscriptions/{billingSubscriptionId}": {
      "get": {
        "operationId": "billing_subscription_retrieve",
        "tags": [
          "billing_subscription"
        ],
        "summary": "Retrieve a Billing subscription",
        "description": "Retrieve a single Billing subscription by its billingSubscriptionId. A Product's subscription inside one billing period: the plan it runs on, when it started, and when it was cancelled.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "billing_subscription.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "billing_subscription.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "billing_subscription",
              "action": "read",
              "tenantScoped": true,
              "idPath": "billingSubscriptionId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Billing subscription",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Billing periods"
          ],
          "publicNoun": "Billing subscription",
          "resourceRef": "billing_subscription",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "billingSubscriptionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.billingSubscriptionRetrieve({\n  path: {\n    billingSubscriptionId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingSubscriptionRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "billingSubscriptionId": "bsub_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/blueprints": {
      "get": {
        "operationId": "blueprint_list",
        "tags": [
          "blueprint"
        ],
        "summary": "List blueprints",
        "description": "Lists every available Blueprint with the business objects and actions it includes. Public and unauthenticated so customers can evaluate Hyperscale before signup.",
        "security": [],
        "x-hyperscale-operation": "blueprint.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "blueprint.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "public",
          "tenant": {
            "mode": "none"
          },
          "resources": [],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List blueprints",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.blueprintList({\n  query: {\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BlueprintListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/blueprints/{blueprintId}": {
      "get": {
        "operationId": "blueprint_retrieve",
        "tags": [
          "blueprint"
        ],
        "summary": "Retrieve a blueprint",
        "description": "Retrieves one Blueprint with its identity, SDK namespace, business objects, lifecycle states, and available actions.",
        "security": [],
        "x-hyperscale-operation": "blueprint.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "blueprint.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "public",
          "tenant": {
            "mode": "none"
          },
          "resources": [],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a blueprint",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "blueprintId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^[a-z][a-z0-9_-]{2,80}$",
              "description": "Commercial blueprint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.blueprintRetrieve({\n  path: {\n    blueprintId: \"resource_sandbox_example0001\",\n  },\n});"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BlueprintRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "id": "resource_sandbox_example0001",
                      "name": "Sandbox account",
                      "summary": "Sandbox capability summary.",
                      "description": "Sandbox operation description.",
                      "sdkNamespace": "accounts",
                      "nouns": [],
                      "customNouns": [],
                      "hsx": "{\n  \"hsx\": 1,\n  \"product\": \"sandbox_marketplace\",\n  \"title\": \"Sandbox Marketplace\"\n}\n"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-authorizations": {
      "post": {
        "operationId": "card_authorization_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Request a card authorization",
        "description": "Records one pending merchant request against an active virtual card. No money is held before approval.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card_authorization:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.requested",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "settlementAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_authorization.requested"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Request a card authorization",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_authorization.requested",
            "operation": "card_authorization.create",
            "operationId": "card_authorization_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardAuthorizationCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_cards000001\",\n    cardId: \"card_sandbox_virtual00001\",\n    cardAccountId: \"acct_sandbox_cardfund0001\",\n    settlementAccountId: \"acct_sandbox_merchant0001\",\n    amount: \"12500\",\n    currency: \"SAR\",\n    merchantName: \"Riyadh Camera Store\",\n    merchantCategory: \"electronics\",\n    merchantCountry: \"SA\",\n    merchantReference: \"merchant-order-1042\",\n    expiresAt: \"2026-07-16T12:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardAuthorizationCreateInput"
              },
              "examples": {
                "request_retail_authorization": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardId": "card_sandbox_virtual00001",
                    "cardAccountId": "acct_sandbox_cardfund0001",
                    "settlementAccountId": "acct_sandbox_merchant0001",
                    "amount": "12500",
                    "currency": "SAR",
                    "merchantName": "Riyadh Camera Store",
                    "merchantCategory": "electronics",
                    "merchantCountry": "SA",
                    "merchantReference": "merchant-order-1042",
                    "expiresAt": "2026-07-16T12:00:00.000Z"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardId": "card_sandbox_virtual00001",
                    "cardAccountId": "acct_sandbox_cardfund0001",
                    "settlementAccountId": "acct_sandbox_merchant0001",
                    "amount": "12500",
                    "currency": "SAR",
                    "merchantName": "Riyadh Camera Store",
                    "merchantCategory": "electronics",
                    "merchantCountry": "SA",
                    "merchantReference": "merchant-order-1042",
                    "expiresAt": "2026-07-16T12:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardAuthorizationId": "cau_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_authorization",
                      "status": "pending",
                      "fields": {
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantName": "Sandbox Merchant",
                        "merchantCategory": "customer_request",
                        "merchantCountry": "SA",
                        "merchantReference": "REF-SANDBOX-0001",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "authorizationTransferId": "cau_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "card_authorization_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List card authorizations",
        "description": "List card authorizations",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card_authorization:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List card authorizations",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "approved",
                "captured",
                "declined",
                "reversed",
                "expired"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "cardId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Active card presented for this authorization"
            }
          },
          {
            "name": "cardAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "settlementAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "merchantCategory",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{1,79}$"
            }
          },
          {
            "name": "merchantCountry",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 2,
              "maxLength": 2,
              "pattern": "^[A-Z]{2}$",
              "description": "ISO 3166-1 alpha-2 country code"
            }
          },
          {
            "name": "expiresAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"pending\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    cardId: \"card_sandbox_example0001\",\n    cardAccountId: \"acct_sandbox_example0001\",\n    settlementAccountId: \"acct_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    merchantCategory: \"customer_request\",\n    merchantCountry: \"SA\",\n    expiresAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-authorizations/{cardAuthorizationId}": {
      "get": {
        "operationId": "card_authorization_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a card authorization",
        "description": "Retrieve a card authorization",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card_authorization:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardAuthorizationId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a card authorization",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "parameters": [
          {
            "name": "cardAuthorizationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card authorization instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationRetrieve({\n  path: {\n    cardAuthorizationId: \"cau_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardAuthorizationId": "cau_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_authorization",
                      "status": "pending",
                      "fields": {
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantName": "Sandbox Merchant",
                        "merchantCategory": "customer_request",
                        "merchantCountry": "SA",
                        "merchantReference": "REF-SANDBOX-0001",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "authorizationTransferId": "cau_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-authorizations/{cardAuthorizationId}/approve": {
      "post": {
        "operationId": "card_authorization_approve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Approve a card authorization",
        "description": "Asks the configured card policy for a just-in-time decision and reserves the immutable authorization amount when approved.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.approve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "card_authorization:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.approved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardAuthorizationId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_authorization.approved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Approve a card authorization",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_authorization.approved",
            "operation": "card_authorization.approve",
            "operationId": "card_authorization_approve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardAuthorizationApproveOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardAuthorizationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card authorization instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationApprove({\n  path: {\n    cardAuthorizationId: \"cau_sandbox_purchase00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_expiry_invalid",
          "transfer_expiry_past",
          "transfer_expiry_too_large",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationApproveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardAuthorizationId": "cau_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_authorization",
                      "status": "approved",
                      "fields": {
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantName": "Sandbox Merchant",
                        "merchantCategory": "customer_request",
                        "merchantCountry": "SA",
                        "merchantReference": "REF-SANDBOX-0001",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "authorizationTransferId": "cau_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_expiry_invalid, transfer_expiry_past, transfer_expiry_too_large, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_expiry_invalid",
              "transfer_expiry_past",
              "transfer_expiry_too_large",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-authorizations/{cardAuthorizationId}/capture": {
      "post": {
        "operationId": "card_authorization_capture",
        "tags": [
          "noun_instance"
        ],
        "summary": "Capture a card authorization",
        "description": "Posts the reserved transfer after the merchant completes the purchase.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.capture",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "card_authorization:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.captured",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardAuthorizationId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "commercial": {
            "earnable": true
          },
          "audit": {
            "event": "card_authorization.captured"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Capture a card authorization",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_authorization.captured",
            "operation": "card_authorization.capture",
            "operationId": "card_authorization_capture",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardAuthorizationCaptureOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardAuthorizationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card authorization instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationCapture({\n  path: {\n    cardAuthorizationId: \"cau_sandbox_purchase00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_post_amount_invalid",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationCaptureOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardAuthorizationId": "cau_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_authorization",
                      "status": "captured",
                      "fields": {
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantName": "Sandbox Merchant",
                        "merchantCategory": "customer_request",
                        "merchantCountry": "SA",
                        "merchantReference": "REF-SANDBOX-0001",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "authorizationTransferId": "cau_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_post_amount_invalid, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_post_amount_invalid",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-authorizations/{cardAuthorizationId}/decline": {
      "post": {
        "operationId": "card_authorization_decline",
        "tags": [
          "noun_instance"
        ],
        "summary": "Decline a card authorization",
        "description": "Closes a pending request without placing a hold after a declined card-policy decision.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.decline",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card_authorization:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.declined",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardAuthorizationId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_authorization.declined"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Decline a card authorization",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_authorization.declined",
            "operation": "card_authorization.decline",
            "operationId": "card_authorization_decline",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardAuthorizationDeclineOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardAuthorizationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card authorization instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationDecline({\n  path: {\n    cardAuthorizationId: \"cau_sandbox_purchase00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationDeclineOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardAuthorizationId": "cau_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_authorization",
                      "status": "declined",
                      "fields": {
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantName": "Sandbox Merchant",
                        "merchantCategory": "customer_request",
                        "merchantCountry": "SA",
                        "merchantReference": "REF-SANDBOX-0001",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "authorizationTransferId": "cau_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-authorizations/{cardAuthorizationId}/reverse": {
      "post": {
        "operationId": "card_authorization_reverse",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reverse a card authorization",
        "description": "Voids an approved hold before capture and releases the card funds.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_authorization.reverse",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "card_authorization:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_authorization.reversed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardAuthorizationId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_authorization.reversed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reverse a card authorization",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card authorizations"
          ],
          "publicNoun": "Card authorization",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_authorization"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_authorization.reversed",
            "operation": "card_authorization.reverse",
            "operationId": "card_authorization_reverse",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardAuthorizationReverseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardAuthorizationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card authorization instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardAuthorizationReverse({\n  path: {\n    cardAuthorizationId: \"cau_sandbox_purchase00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "destination_account_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardAuthorizationReverseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardAuthorizationId": "cau_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_authorization",
                      "status": "reversed",
                      "fields": {
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantName": "Sandbox Merchant",
                        "merchantCategory": "customer_request",
                        "merchantCountry": "SA",
                        "merchantReference": "REF-SANDBOX-0001",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "authorizationTransferId": "cau_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-disputes": {
      "post": {
        "operationId": "card_dispute_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "File a card dispute",
        "description": "Files an evidence-backed challenge against one transaction that is still posted. The disputed amount, currency, card, and account pair are derived from the locked transaction -- never caller-supplied.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_dispute.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card_dispute:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_dispute.filed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardTransactionId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_dispute.filed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "File a card dispute",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card disputes"
          ],
          "publicNoun": "Card dispute",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_dispute"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_dispute.filed",
            "operation": "card_dispute.create",
            "operationId": "card_dispute_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardDisputeCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardDisputeCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_cards000001\",\n    cardTransactionId: \"ctx_sandbox_purchase00001\",\n    reason: \"unauthorized_purchase\",\n    evidence: [\n      {\n        kind: \"customer_statement\",\n        summary: \"Customer confirms the purchase was not authorized.\",\n        reference: \"support-case-2048\",\n        submittedAt: \"2026-07-11T10:15:00.000Z\",\n      },\n    ],\n    responseDueAt: \"2026-08-10T23:59:59.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardDisputeCreateInput"
              },
              "examples": {
                "file_unauthorized_purchase_dispute": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardTransactionId": "ctx_sandbox_purchase00001",
                    "reason": "unauthorized_purchase",
                    "evidence": [
                      {
                        "kind": "customer_statement",
                        "summary": "Customer confirms the purchase was not authorized.",
                        "reference": "support-case-2048",
                        "submittedAt": "2026-07-11T10:15:00.000Z"
                      }
                    ],
                    "responseDueAt": "2026-08-10T23:59:59.000Z"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardTransactionId": "ctx_sandbox_purchase00001",
                    "reason": "unauthorized_purchase",
                    "evidence": [
                      {
                        "kind": "customer_statement",
                        "summary": "Customer confirms the purchase was not authorized.",
                        "reference": "support-case-2048",
                        "submittedAt": "2026-07-11T10:15:00.000Z"
                      }
                    ],
                    "responseDueAt": "2026-08-10T23:59:59.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardDisputeId": "cdis_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_dispute",
                      "status": "filed",
                      "fields": {
                        "cardTransactionId": "ctx_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "reason": "customer_request",
                        "evidence": [
                          {
                            "kind": "customer_request",
                            "summary": "Sandbox capability summary.",
                            "submittedAt": "2026-01-01T00:00:00.000Z"
                          }
                        ],
                        "responseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "disputeTransferId": "dsp_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "card_dispute_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List card disputes",
        "description": "List card disputes",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_dispute.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card_dispute:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_dispute.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List card disputes",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card disputes"
          ],
          "publicNoun": "Card dispute",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_dispute"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "filed",
                "under_review",
                "won",
                "lost"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "cardTransactionId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Posted card transaction challenged by this dispute"
            }
          },
          {
            "name": "cardId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card whose transaction is challenged"
            }
          },
          {
            "name": "cardAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "settlementAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "reason",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{1,79}$"
            }
          },
          {
            "name": "responseDueAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardDisputeList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"filed\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    cardTransactionId: \"ctx_sandbox_example0001\",\n    cardId: \"card_sandbox_example0001\",\n    cardAccountId: \"acct_sandbox_example0001\",\n    settlementAccountId: \"acct_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    reason: \"customer_request\",\n    responseDueAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-disputes/{cardDisputeId}": {
      "get": {
        "operationId": "card_dispute_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a card dispute",
        "description": "Retrieve a card dispute",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_dispute.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card_dispute:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_dispute.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardDisputeId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a card dispute",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card disputes"
          ],
          "publicNoun": "Card dispute",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_dispute"
        ],
        "parameters": [
          {
            "name": "cardDisputeId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card dispute instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardDisputeRetrieve({\n  path: {\n    cardDisputeId: \"cdis_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardDisputeId": "cdis_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_dispute",
                      "status": "filed",
                      "fields": {
                        "cardTransactionId": "ctx_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "reason": "customer_request",
                        "evidence": [
                          {
                            "kind": "customer_request",
                            "summary": "Sandbox capability summary.",
                            "submittedAt": "2026-01-01T00:00:00.000Z"
                          }
                        ],
                        "responseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "disputeTransferId": "dsp_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "card_dispute_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a card dispute",
        "description": "Edits the mutable fields of a card dispute (evidence) while it is filed or under_review. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_dispute.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card_dispute:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_dispute.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardDisputeId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "card_dispute.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a card dispute",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card disputes"
          ],
          "publicNoun": "Card dispute",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_dispute"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_dispute.updated",
            "operation": "card_dispute.update",
            "operationId": "card_dispute_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardDisputeUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardDisputeId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card dispute instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardDisputeUpdate({\n  path: {\n    cardDisputeId: \"cdis_sandbox_purchase0001\",\n  },\n  body: {\n    evidence: [\n      {\n        kind: \"customer_statement\",\n        summary: \"Customer confirms the purchase was not authorized.\",\n        reference: \"support-case-2048\",\n        submittedAt: \"2026-07-11T10:15:00.000Z\",\n      },\n      {\n        kind: \"merchant_correspondence\",\n        summary: \"Merchant could not produce proof of delivery.\",\n        submittedAt: \"2026-07-12T09:30:00.000Z\",\n      },\n    ],\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardDisputeUpdateBody"
              },
              "examples": {
                "add_card_dispute_evidence": {
                  "value": {
                    "evidence": [
                      {
                        "kind": "customer_statement",
                        "summary": "Customer confirms the purchase was not authorized.",
                        "reference": "support-case-2048",
                        "submittedAt": "2026-07-11T10:15:00.000Z"
                      },
                      {
                        "kind": "merchant_correspondence",
                        "summary": "Merchant could not produce proof of delivery.",
                        "submittedAt": "2026-07-12T09:30:00.000Z"
                      }
                    ]
                  }
                },
                "default": {
                  "value": {
                    "evidence": [
                      {
                        "kind": "customer_statement",
                        "summary": "Customer confirms the purchase was not authorized.",
                        "reference": "support-case-2048",
                        "submittedAt": "2026-07-11T10:15:00.000Z"
                      },
                      {
                        "kind": "merchant_correspondence",
                        "summary": "Merchant could not produce proof of delivery.",
                        "submittedAt": "2026-07-12T09:30:00.000Z"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardDisputeId": "cdis_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_dispute",
                      "status": "filed",
                      "fields": {
                        "cardTransactionId": "ctx_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "reason": "customer_request",
                        "evidence": [
                          {
                            "kind": "customer_request",
                            "summary": "Sandbox capability summary.",
                            "submittedAt": "2026-01-01T00:00:00.000Z"
                          }
                        ],
                        "responseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "disputeTransferId": "dsp_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-disputes/{cardDisputeId}/review": {
      "post": {
        "operationId": "card_dispute_review",
        "tags": [
          "noun_instance"
        ],
        "summary": "Review a card dispute",
        "description": "Accepts the filed evidence for an outcome decision before the response deadline.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_dispute.review",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card_dispute:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_dispute.reviewed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardDisputeId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_dispute.reviewed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Review a card dispute",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card disputes"
          ],
          "publicNoun": "Card dispute",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_dispute"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_dispute.reviewed",
            "operation": "card_dispute.review",
            "operationId": "card_dispute_review",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardDisputeReviewOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardDisputeId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card dispute instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardDisputeReview({\n  path: {\n    cardDisputeId: \"cdis_sandbox_purchase0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeReviewOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardDisputeId": "cdis_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_dispute",
                      "status": "under_review",
                      "fields": {
                        "cardTransactionId": "ctx_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "reason": "customer_request",
                        "evidence": [
                          {
                            "kind": "customer_request",
                            "summary": "Sandbox capability summary.",
                            "submittedAt": "2026-01-01T00:00:00.000Z"
                          }
                        ],
                        "responseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "disputeTransferId": "dsp_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-disputes/{cardDisputeId}/win": {
      "post": {
        "operationId": "card_dispute_win",
        "tags": [
          "noun_instance"
        ],
        "summary": "Win a card dispute",
        "description": "Asks the configured card policy for the final outcome and returns the disputed amount when the cardholder wins.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_dispute.win",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "card_dispute:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_dispute.won",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardDisputeId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "card_dispute.won"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Win a card dispute",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card disputes"
          ],
          "publicNoun": "Card dispute",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_dispute"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_dispute.won",
            "operation": "card_dispute.win",
            "operationId": "card_dispute_win",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardDisputeWinOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardDisputeId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cdis_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card dispute instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardDisputeWin({\n  path: {\n    cardDisputeId: \"cdis_sandbox_purchase0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardDisputeWinOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardDisputeId": "cdis_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_dispute",
                      "status": "won",
                      "fields": {
                        "cardTransactionId": "ctx_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "reason": "customer_request",
                        "evidence": [
                          {
                            "kind": "customer_request",
                            "summary": "Sandbox capability summary.",
                            "submittedAt": "2026-01-01T00:00:00.000Z"
                          }
                        ],
                        "responseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "disputeTransferId": "dsp_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-transactions": {
      "post": {
        "operationId": "card_transaction_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Record a card transaction",
        "description": "Records the posted purchase produced by one captured authorization. The amount, currency, card, and account pair are derived from the locked captured authorization -- never caller-supplied -- and each authorization settles into at most one transaction.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_transaction.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card_transaction:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_transaction.posted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardAuthorizationId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card_transaction.posted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Record a card transaction",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card transactions"
          ],
          "publicNoun": "Card transaction",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_transaction"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_transaction.posted",
            "operation": "card_transaction.create",
            "operationId": "card_transaction_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardTransactionCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardTransactionCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_cards000001\",\n    cardAuthorizationId: \"cau_sandbox_purchase00001\",\n    postedAt: \"2026-07-10T12:05:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_already_claimed",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardTransactionCreateInput"
              },
              "examples": {
                "record_captured_card_purchase": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardAuthorizationId": "cau_sandbox_purchase00001",
                    "postedAt": "2026-07-10T12:05:00.000Z"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardAuthorizationId": "cau_sandbox_purchase00001",
                    "postedAt": "2026-07-10T12:05:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardTransactionId": "ctx_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_transaction",
                      "status": "posted",
                      "fields": {
                        "cardAuthorizationId": "cau_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantReference": "REF-SANDBOX-0001",
                        "postedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_already_claimed, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_already_claimed",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "card_transaction_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List card transactions",
        "description": "List card transactions",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_transaction.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card_transaction:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_transaction.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List card transactions",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card transactions"
          ],
          "publicNoun": "Card transaction",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_transaction"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "posted",
                "refunded"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "cardAuthorizationId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cau_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Captured authorization settled by this transaction"
            }
          },
          {
            "name": "cardId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card used for this transaction"
            }
          },
          {
            "name": "cardAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "settlementAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "postedAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardTransactionList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"posted\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    cardAuthorizationId: \"cau_sandbox_example0001\",\n    cardId: \"card_sandbox_example0001\",\n    cardAccountId: \"acct_sandbox_example0001\",\n    settlementAccountId: \"acct_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    postedAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-transactions/{cardTransactionId}": {
      "get": {
        "operationId": "card_transaction_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a card transaction",
        "description": "Retrieve a card transaction",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_transaction.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card_transaction:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_transaction.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardTransactionId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a card transaction",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card transactions"
          ],
          "publicNoun": "Card transaction",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_transaction"
        ],
        "parameters": [
          {
            "name": "cardTransactionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card transaction instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardTransactionRetrieve({\n  path: {\n    cardTransactionId: \"ctx_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardTransactionId": "ctx_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_transaction",
                      "status": "posted",
                      "fields": {
                        "cardAuthorizationId": "cau_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantReference": "REF-SANDBOX-0001",
                        "postedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/card-transactions/{cardTransactionId}/refund": {
      "post": {
        "operationId": "card_transaction_refund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund a card transaction",
        "description": "Returns the full posted amount from the settlement account to the card account and closes the transaction as refunded.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card_transaction.refund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "card_transaction:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card_transaction.refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardTransactionId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "card_transaction.refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund a card transaction",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Card transactions"
          ],
          "publicNoun": "Card transaction",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card_transaction"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card_transaction.refunded",
            "operation": "card_transaction.refund",
            "operationId": "card_transaction_refund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardTransactionRefundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardTransactionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ctx_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card transaction instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardTransactionRefund({\n  path: {\n    cardTransactionId: \"ctx_sandbox_purchase00001\",\n  },\n  body: {\n    reason: \"Merchant accepted the returned item\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardTransactionRefundBody"
              },
              "examples": {
                "refund_returned_purchase": {
                  "value": {
                    "reason": "Merchant accepted the returned item"
                  }
                },
                "default": {
                  "value": {
                    "reason": "Merchant accepted the returned item"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardTransactionRefundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardTransactionId": "ctx_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card_transaction",
                      "status": "refunded",
                      "fields": {
                        "cardAuthorizationId": "cau_sandbox_example0001",
                        "cardId": "card_sandbox_example0001",
                        "cardAccountId": "acct_sandbox_example0001",
                        "settlementAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "merchantReference": "REF-SANDBOX-0001",
                        "postedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cardholders": {
      "post": {
        "operationId": "cardholder_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a cardholder",
        "description": "Creates a pending cardholder for one verified first-party customer.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "cardholder:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "customer",
              "action": "read",
              "tenantScoped": true,
              "idPath": "customerId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "cardholder.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a cardholder",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "cardholder.created",
            "operation": "cardholder.create",
            "operationId": "cardholder_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardholderCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_cards000001\",\n    customerId: \"cus_sandbox_customer0001\",\n    displayName: \"Noura Al Saud\",\n    email: \"noura@example.test\",\n    phoneNumber: \"+966500000001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardholderCreateInput"
              },
              "examples": {
                "create_customer_cardholder": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "customerId": "cus_sandbox_customer0001",
                    "displayName": "Noura Al Saud",
                    "email": "noura@example.test",
                    "phoneNumber": "+966500000001"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "customerId": "cus_sandbox_customer0001",
                    "displayName": "Noura Al Saud",
                    "email": "noura@example.test",
                    "phoneNumber": "+966500000001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "pending",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "cardholder_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List cardholders",
        "description": "List cardholders",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "cardholder:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List cardholders",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "active",
                "suspended",
                "closed"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "customerId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cus_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Tenant-local customer ID"
            }
          },
          {
            "name": "email",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "email",
              "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"pending\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    customerId: \"cus_sandbox_example0001\",\n    email: \"operator@example.com\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cardholders/{cardholderId}": {
      "get": {
        "operationId": "cardholder_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a cardholder",
        "description": "Retrieve a cardholder",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "cardholder:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardholderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a cardholder",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "parameters": [
          {
            "name": "cardholderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Cardholder instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderRetrieve({\n  path: {\n    cardholderId: \"chd_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "pending",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "cardholder_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a cardholder",
        "description": "Edits the mutable fields of a cardholder (displayName, email, phoneNumber) while it is pending or active or suspended. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "cardholder:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardholderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "cardholder.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a cardholder",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "cardholder.updated",
            "operation": "cardholder.update",
            "operationId": "cardholder_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardholderUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardholderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Cardholder instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderUpdate({\n  path: {\n    cardholderId: \"chd_sandbox_customer0001\",\n  },\n  body: {\n    displayName: \"Noura Al Saud\",\n    email: \"noura@example.test\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardholderUpdateBody"
              },
              "examples": {
                "update_cardholder_contact": {
                  "value": {
                    "displayName": "Noura Al Saud",
                    "email": "noura@example.test"
                  }
                },
                "default": {
                  "value": {
                    "displayName": "Noura Al Saud",
                    "email": "noura@example.test"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "pending",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cardholders/{cardholderId}/activate": {
      "post": {
        "operationId": "cardholder_activate",
        "tags": [
          "noun_instance"
        ],
        "summary": "Activate a cardholder",
        "description": "Approves the customer to hold and use cards.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.activate",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "cardholder:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.activated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardholderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "cardholder.activated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Activate a cardholder",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "cardholder.activated",
            "operation": "cardholder.activate",
            "operationId": "cardholder_activate",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardholderActivateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardholderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Cardholder instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderActivate({\n  path: {\n    cardholderId: \"chd_sandbox_customer0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderActivateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "active",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cardholders/{cardholderId}/close": {
      "post": {
        "operationId": "cardholder_close",
        "tags": [
          "noun_instance"
        ],
        "summary": "Close a cardholder",
        "description": "Permanently ends the customer's cardholder relationship. Existing cards must be canceled separately.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "cardholder:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardholderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "cardholder.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Close a cardholder",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "cardholder.closed",
            "operation": "cardholder.close",
            "operationId": "cardholder_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardholderCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardholderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Cardholder instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderClose({\n  path: {\n    cardholderId: \"chd_sandbox_customer0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "closed",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cardholders/{cardholderId}/resume": {
      "post": {
        "operationId": "cardholder_resume",
        "tags": [
          "noun_instance"
        ],
        "summary": "Resume a cardholder",
        "description": "Restores card access after a suspension is resolved.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.resume",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "cardholder:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.resumed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardholderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "cardholder.resumed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Resume a cardholder",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "cardholder.resumed",
            "operation": "cardholder.resume",
            "operationId": "cardholder_resume",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardholderResumeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardholderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Cardholder instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderResume({\n  path: {\n    cardholderId: \"chd_sandbox_customer0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderResumeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "active",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cardholders/{cardholderId}/suspend": {
      "post": {
        "operationId": "cardholder_suspend",
        "tags": [
          "noun_instance"
        ],
        "summary": "Suspend a cardholder",
        "description": "Pauses the customer's card access without closing the cardholder.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "cardholder.suspend",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "cardholder:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "cardholder.suspended",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardholderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "cardholder.suspended"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Suspend a cardholder",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cardholders"
          ],
          "publicNoun": "Cardholder",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "cardholder"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "cardholder.suspended",
            "operation": "cardholder.suspend",
            "operationId": "cardholder_suspend",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardholderSuspendOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardholderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Cardholder instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardholderSuspend({\n  path: {\n    cardholderId: \"chd_sandbox_customer0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardholderSuspendOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardholderId": "chd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "cardholder",
                      "status": "suspended",
                      "fields": {
                        "customerId": "cus_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cards": {
      "post": {
        "operationId": "card_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Issue a card",
        "description": "Issues a virtual card to one active cardholder and binds its spend controls and funding account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.issued",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardholderId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card.issued"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Issue a card",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card.issued",
            "operation": "card.create",
            "operationId": "card_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_cards000001\",\n    cardholderId: \"chd_sandbox_customer0001\",\n    accountId: \"acct_sandbox_cardfund0001\",\n    currency: \"SAR\",\n    label: \"Primary virtual card\",\n    spendControls: {\n      singlePurchaseLimit: \"50000\",\n      dailyLimit: \"100000\",\n      monthlyLimit: \"500000\",\n      allowedMerchantCategories: [\n        \"retail\",\n        \"travel\",\n        \"lodging\",\n      ],\n      allowedCountries: [\n        \"SA\",\n      ],\n    },\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardCreateInput"
              },
              "examples": {
                "issue_controlled_virtual_card": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardholderId": "chd_sandbox_customer0001",
                    "accountId": "acct_sandbox_cardfund0001",
                    "currency": "SAR",
                    "label": "Primary virtual card",
                    "spendControls": {
                      "singlePurchaseLimit": "50000",
                      "dailyLimit": "100000",
                      "monthlyLimit": "500000",
                      "allowedMerchantCategories": [
                        "retail",
                        "travel",
                        "lodging"
                      ],
                      "allowedCountries": [
                        "SA"
                      ]
                    }
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_cards000001",
                    "cardholderId": "chd_sandbox_customer0001",
                    "accountId": "acct_sandbox_cardfund0001",
                    "currency": "SAR",
                    "label": "Primary virtual card",
                    "spendControls": {
                      "singlePurchaseLimit": "50000",
                      "dailyLimit": "100000",
                      "monthlyLimit": "500000",
                      "allowedMerchantCategories": [
                        "retail",
                        "travel",
                        "lodging"
                      ],
                      "allowedCountries": [
                        "SA"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "issued",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "card_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List cards",
        "description": "List cards",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List cards",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "issued",
                "active",
                "frozen",
                "canceled"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "cardholderId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^chd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Active cardholder receiving this card"
            }
          },
          {
            "name": "accountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"issued\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    cardholderId: \"chd_sandbox_example0001\",\n    accountId: \"acct_sandbox_example0001\",\n    currency: \"SAR\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cards/{cardId}": {
      "get": {
        "operationId": "card_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a card",
        "description": "Retrieve a card",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "card:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "cardId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a card",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "parameters": [
          {
            "name": "cardId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardRetrieve({\n  path: {\n    cardId: \"card_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "issued",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "card_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a card",
        "description": "Edits the mutable fields of a card (label, spendControls) while it is issued or active or frozen. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "card.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a card",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card.updated",
            "operation": "card.update",
            "operationId": "card_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardUpdate({\n  path: {\n    cardId: \"card_sandbox_virtual00001\",\n  },\n  body: {\n    label: \"Travel card\",\n    spendControls: {\n      singlePurchaseLimit: \"25000\",\n      dailyLimit: \"50000\",\n      monthlyLimit: \"200000\",\n      allowedMerchantCategories: [\n        \"travel\",\n        \"lodging\",\n      ],\n      allowedCountries: [\n        \"SA\",\n        \"AE\",\n      ],\n    },\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CardUpdateBody"
              },
              "examples": {
                "tighten_virtual_card_controls": {
                  "value": {
                    "label": "Travel card",
                    "spendControls": {
                      "singlePurchaseLimit": "25000",
                      "dailyLimit": "50000",
                      "monthlyLimit": "200000",
                      "allowedMerchantCategories": [
                        "travel",
                        "lodging"
                      ],
                      "allowedCountries": [
                        "SA",
                        "AE"
                      ]
                    }
                  }
                },
                "default": {
                  "value": {
                    "label": "Travel card",
                    "spendControls": {
                      "singlePurchaseLimit": "25000",
                      "dailyLimit": "50000",
                      "monthlyLimit": "200000",
                      "allowedMerchantCategories": [
                        "travel",
                        "lodging"
                      ],
                      "allowedCountries": [
                        "SA",
                        "AE"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "issued",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cards/{cardId}/activate": {
      "post": {
        "operationId": "card_activate",
        "tags": [
          "noun_instance"
        ],
        "summary": "Activate a card",
        "description": "Makes the issued virtual card available for authorization.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.activate",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.activated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card.activated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Activate a card",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card.activated",
            "operation": "card.activate",
            "operationId": "card_activate",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardActivateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardActivate({\n  path: {\n    cardId: \"card_sandbox_virtual00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardActivateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "active",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cards/{cardId}/cancel": {
      "post": {
        "operationId": "card_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel a card",
        "description": "Permanently stops the virtual card. Existing posted transactions remain part of its history.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a card",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card.canceled",
            "operation": "card.cancel",
            "operationId": "card_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardCancel({\n  path: {\n    cardId: \"card_sandbox_virtual00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "canceled",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cards/{cardId}/freeze": {
      "post": {
        "operationId": "card_freeze",
        "tags": [
          "noun_instance"
        ],
        "summary": "Freeze a card",
        "description": "Stops new authorizations while preserving the card and its history.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.freeze",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.freezed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card.freezed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Freeze a card",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card.freezed",
            "operation": "card.freeze",
            "operationId": "card_freeze",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardFreezeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardFreeze({\n  path: {\n    cardId: \"card_sandbox_virtual00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardFreezeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "frozen",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/cards/{cardId}/unfreeze": {
      "post": {
        "operationId": "card_unfreeze",
        "tags": [
          "noun_instance"
        ],
        "summary": "Unfreeze a card",
        "description": "Restores authorization after a temporary freeze.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "card.unfreeze",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "card:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "card.unfrozen",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "cardId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "card.unfrozen"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Unfreeze a card",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Cards"
          ],
          "publicNoun": "Card",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "card"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "card.unfrozen",
            "operation": "card.unfreeze",
            "operationId": "card_unfreeze",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CardUnfreezeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "cardId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^card_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Card instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.cardUnfreeze({\n  path: {\n    cardId: \"card_sandbox_virtual00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CardUnfreezeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "cardId": "card_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "card",
                      "status": "active",
                      "fields": {
                        "cardholderId": "chd_sandbox_example0001",
                        "accountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "label": "Sandbox label",
                        "spendControls": {
                          "singlePurchaseLimit": "1",
                          "dailyLimit": "1",
                          "monthlyLimit": "1"
                        }
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/charges": {
      "get": {
        "operationId": "charge_list",
        "tags": [
          "charge"
        ],
        "summary": "List Charges",
        "description": "List Charges as a cursor-paginated page. A single billable amount raised against a billing period, carrying the transfer it settled through once it has been paid.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "charge.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "charge.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "charge",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Charges",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Charges"
          ],
          "publicNoun": "Charge",
          "resourceRef": "charge",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "billingPeriodId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale billing period ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "accepted",
                "posted",
                "voided",
                "failed"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.chargeList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    billingPeriodId: \"bper_sandbox_example0001\",\n    status: \"accepted\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargeListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/charges/{chargeId}": {
      "get": {
        "operationId": "charge_retrieve",
        "tags": [
          "charge"
        ],
        "summary": "Retrieve a Charge",
        "description": "Retrieve a single Charge by its chargeId. A single billable amount raised against a billing period, carrying the transfer it settled through once it has been paid.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "charge.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "charge.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "charge",
              "action": "read",
              "tenantScoped": true,
              "idPath": "chargeId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Charge",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Charges"
          ],
          "publicNoun": "Charge",
          "resourceRef": "charge",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "chargeId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.chargeRetrieve({\n  path: {\n    chargeId: \"chg_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChargeRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "chargeId": "chg_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "description": "Sandbox operation description.",
                        "debitAccountId": "acct_sandbox_example0001",
                        "creditAccountId": "acct_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/circle-memberships": {
      "post": {
        "operationId": "circle_membership_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Join a savings circle",
        "description": "Takes a seat in a forming circle, copying the pot account, contribution amount, currency, start moment, and term count from the locked circle. The organizer authors the seat's rotation position, payout moment, and payout amount. No money moves at join.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "circle_membership.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "circle_membership:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "circle_membership.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "savingsCircleId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "memberAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "circle_membership.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Join a savings circle",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Circle Memberships"
          ],
          "publicNoun": "Circle membership",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "circle_membership"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "circle_membership.created",
            "operation": "circle_membership.create",
            "operationId": "circle_membership_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CircleMembershipCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.circleMembershipCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_jamiya00001\",\n    savingsCircleId: \"jam_sandbox_alharbi0001\",\n    memberAccountId: \"acct_sandbox_member0001\",\n    position: 0,\n    receiveAt: \"2026-08-20T21:00:00.000Z\",\n    payoutAmount: \"300000\",\n    joinedAt: \"2026-07-25T09:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CircleMembershipCreateInput"
              },
              "examples": {
                "join_family_circle": {
                  "value": {
                    "workspaceId": "wsp_sandbox_jamiya00001",
                    "savingsCircleId": "jam_sandbox_alharbi0001",
                    "memberAccountId": "acct_sandbox_member0001",
                    "position": 0,
                    "receiveAt": "2026-08-20T21:00:00.000Z",
                    "payoutAmount": "300000",
                    "joinedAt": "2026-07-25T09:00:00.000Z"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_jamiya00001",
                    "savingsCircleId": "jam_sandbox_alharbi0001",
                    "memberAccountId": "acct_sandbox_member0001",
                    "position": 0,
                    "receiveAt": "2026-08-20T21:00:00.000Z",
                    "payoutAmount": "300000",
                    "joinedAt": "2026-07-25T09:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CircleMembershipCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "circleMembershipId": "jmm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "circle_membership",
                      "status": "joined",
                      "fields": {
                        "savingsCircleId": "jam_sandbox_example0001",
                        "memberAccountId": "acct_sandbox_example0001",
                        "potAccountId": "acct_sandbox_example0001",
                        "contributionAmount": "1",
                        "currency": "SAR",
                        "startAt": "2026-01-01T00:00:00.000Z",
                        "termCount": 2,
                        "position": 0,
                        "receiveAt": "2026-01-01T00:00:00.000Z",
                        "payoutAmount": "1",
                        "joinedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "contributionTransferId": "resource_sandbox_example0001",
                        "payoutTransferId": "pay_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "circle_membership_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List circle memberships",
        "description": "List circle memberships",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "circle_membership.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "circle_membership:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "circle_membership.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List circle memberships",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Circle Memberships"
          ],
          "publicNoun": "Circle membership",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "circle_membership"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "joined",
                "active",
                "paid",
                "withdrawn"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "savingsCircleId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Savings circle this seat belongs to"
            }
          },
          {
            "name": "memberAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "potAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "contributionAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "contributionAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "startAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "receiveAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "payoutAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "payoutAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "joinedAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.circleMembershipList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"joined\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    savingsCircleId: \"jam_sandbox_example0001\",\n    memberAccountId: \"acct_sandbox_example0001\",\n    potAccountId: \"acct_sandbox_example0001\",\n    contributionAmountFrom: \"1\",\n    contributionAmountTo: \"1\",\n    currency: \"SAR\",\n    startAt: \"2026-01-01T00:00:00.000Z\",\n    receiveAt: \"2026-01-01T00:00:00.000Z\",\n    payoutAmountFrom: \"1\",\n    payoutAmountTo: \"1\",\n    joinedAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CircleMembershipListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/circle-memberships/{circleMembershipId}": {
      "get": {
        "operationId": "circle_membership_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a circle membership",
        "description": "Retrieve a circle membership",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "circle_membership.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "circle_membership:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "circle_membership.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "circleMembershipId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a circle membership",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Circle Memberships"
          ],
          "publicNoun": "Circle membership",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "circle_membership"
        ],
        "parameters": [
          {
            "name": "circleMembershipId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^jmm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Circle membership instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.circleMembershipRetrieve({\n  path: {\n    circleMembershipId: \"jmm_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CircleMembershipRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "circleMembershipId": "jmm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "circle_membership",
                      "status": "joined",
                      "fields": {
                        "savingsCircleId": "jam_sandbox_example0001",
                        "memberAccountId": "acct_sandbox_example0001",
                        "potAccountId": "acct_sandbox_example0001",
                        "contributionAmount": "1",
                        "currency": "SAR",
                        "startAt": "2026-01-01T00:00:00.000Z",
                        "termCount": 2,
                        "position": 0,
                        "receiveAt": "2026-01-01T00:00:00.000Z",
                        "payoutAmount": "1",
                        "joinedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "contributionTransferId": "resource_sandbox_example0001",
                        "payoutTransferId": "pay_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims": {
      "post": {
        "operationId": "claim_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "File a claim",
        "description": "Records a demand against an active policy and reserves its filed amount against the policy's aggregate coverage limit.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "claim:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.filed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "policyId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "claimantAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "insurerAccountId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "claim.filed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "File a claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.filed",
            "operation": "claim.create",
            "operationId": "claim_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_protection01\",\n    subject: \"sbj_sandbox_protection001\",\n    policyId: \"pol_sandbox_protection001\",\n    claimantAccountId: \"acct_sandbox_holder00001\",\n    insurerAccountId: \"acct_sandbox_insurer0001\",\n    claimAmount: \"75000\",\n    currency: \"SAR\",\n    peril: \"accidental_damage\",\n    occurredAt: \"2026-10-14T11:30:00.000Z\",\n    evidenceSummary: \"Covered equipment was damaged in an accidental fall.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClaimCreateInput"
              },
              "examples": {
                "file_accidental_damage_claim": {
                  "value": {
                    "workspaceId": "wsp_sandbox_protection01",
                    "subject": "sbj_sandbox_protection001",
                    "policyId": "pol_sandbox_protection001",
                    "claimantAccountId": "acct_sandbox_holder00001",
                    "insurerAccountId": "acct_sandbox_insurer0001",
                    "claimAmount": "75000",
                    "currency": "SAR",
                    "peril": "accidental_damage",
                    "occurredAt": "2026-10-14T11:30:00.000Z",
                    "evidenceSummary": "Covered equipment was damaged in an accidental fall."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_protection01",
                    "subject": "sbj_sandbox_protection001",
                    "policyId": "pol_sandbox_protection001",
                    "claimantAccountId": "acct_sandbox_holder00001",
                    "insurerAccountId": "acct_sandbox_insurer0001",
                    "claimAmount": "75000",
                    "currency": "SAR",
                    "peril": "accidental_damage",
                    "occurredAt": "2026-10-14T11:30:00.000Z",
                    "evidenceSummary": "Covered equipment was damaged in an accidental fall."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "filed",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_reference_required, noun_reference_status_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "claim_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List claims",
        "description": "List claims",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "claim:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List claims",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "filed",
                "assessed",
                "approved",
                "paid",
                "denied"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "policyId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Active policy this claim is made against"
            }
          },
          {
            "name": "claimantAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "insurerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "claimAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "claimAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "peril",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{1,79}$"
            }
          },
          {
            "name": "occurredAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"filed\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    policyId: \"pol_sandbox_example0001\",\n    claimantAccountId: \"acct_sandbox_example0001\",\n    insurerAccountId: \"acct_sandbox_example0001\",\n    claimAmountFrom: \"1\",\n    claimAmountTo: \"1\",\n    currency: \"SAR\",\n    peril: \"customer_request\",\n    occurredAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}": {
      "get": {
        "operationId": "claim_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a claim",
        "description": "Retrieve a claim",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "claim:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "claimId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a claim",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimRetrieve({\n  path: {\n    claimId: \"clm_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "filed",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "claim_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a claim",
        "description": "Edits the mutable fields of a claim (evidenceSummary) while it is filed or assessed. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "claim:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "claim.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.updated",
            "operation": "claim.update",
            "operationId": "claim_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimUpdate({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n  body: {\n    evidenceSummary: \"Damage assessment confirms the covered accidental event.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClaimUpdateBody"
              },
              "examples": {
                "add_claim_evidence_summary": {
                  "value": {
                    "evidenceSummary": "Damage assessment confirms the covered accidental event."
                  }
                },
                "default": {
                  "value": {
                    "evidenceSummary": "Damage assessment confirms the covered accidental event."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "filed",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}/approve": {
      "post": {
        "operationId": "claim_approve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Approve a claim",
        "description": "Asks the claims adjuster to approve the assessed demand, then holds the immutable claim amount from the insurer for the claimant. For a carrier that exposes an adjudication API: the verdict is the provider's, taken just in time under a deadline.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.approve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "claim:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.approved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "claim.approved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Approve a claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.approved",
            "operation": "claim.approve",
            "operationId": "claim_approve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimApproveOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimApprove({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_expiry_invalid",
          "transfer_expiry_past",
          "transfer_expiry_too_large",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimApproveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "approved",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_expiry_invalid, transfer_expiry_past, transfer_expiry_too_large, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_expiry_invalid",
              "transfer_expiry_past",
              "transfer_expiry_too_large",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}/assess": {
      "post": {
        "operationId": "claim_assess",
        "tags": [
          "noun_instance"
        ],
        "summary": "Assess a claim",
        "description": "Marks filed evidence ready for an approval decision. A claim validly filed during cover continues even if the policy term later expires.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.assess",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "claim:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.assessed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "claim.assessed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Assess a claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.assessed",
            "operation": "claim.assess",
            "operationId": "claim_assess",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimAssessOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimAssess({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimAssessOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "assessed",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}/attest": {
      "post": {
        "operationId": "claim_attest",
        "tags": [
          "noun_instance"
        ],
        "summary": "Attest an out-of-band claim approval",
        "description": "Records the insurer's own approval of the assessed demand, taken outside the platform, and holds the immutable claim amount from the insurer for the claimant. The insurer must be asserted as the acting party. Use this where the carrier exposes no adjudication API; where one exists, approve calls it instead.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.attest",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "claim:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.attested",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "claim.attested"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Attest an out-of-band claim approval",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.attested",
            "operation": "claim.attest",
            "operationId": "claim_attest",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimAttestOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimAttest({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n  body: {\n    actorAccountId: \"acct_sandbox_insurer0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "port_actor_not_allowed",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_expiry_invalid",
          "transfer_expiry_past",
          "transfer_expiry_too_large",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ClaimAttestBody"
              },
              "examples": {
                "attest_insurer_approval": {
                  "value": {
                    "actorAccountId": "acct_sandbox_insurer0001"
                  }
                },
                "default": {
                  "value": {
                    "actorAccountId": "acct_sandbox_insurer0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimAttestOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "approved",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_expiry_invalid, transfer_expiry_past, transfer_expiry_too_large, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_expiry_invalid",
              "transfer_expiry_past",
              "transfer_expiry_too_large",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, port_actor_not_allowed, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "port_actor_not_allowed",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}/deny": {
      "post": {
        "operationId": "claim_deny",
        "tags": [
          "noun_instance"
        ],
        "summary": "Deny a claim",
        "description": "Closes a filed or assessed demand before any payout hold exists.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.deny",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "claim:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.denied",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "claim.denied"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Deny a claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.denied",
            "operation": "claim.deny",
            "operationId": "claim_deny",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimDenyOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimDeny({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimDenyOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "denied",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}/pay": {
      "post": {
        "operationId": "claim_pay",
        "tags": [
          "noun_instance"
        ],
        "summary": "Pay a claim",
        "description": "Posts the approved hold and settles the claim amount into the claimant account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.pay",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "claim:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.paid",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "claim.paid"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Pay a claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.paid",
            "operation": "claim.pay",
            "operationId": "claim_pay",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimPayOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimPay({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_post_amount_invalid",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimPayOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "paid",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_post_amount_invalid, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_post_amount_invalid",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/claims/{claimId}/reverse": {
      "post": {
        "operationId": "claim_reverse",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reverse claim approval",
        "description": "Voids an approved payout hold before payment and closes the claim denied. No settled money is reversed.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "claim.reverse",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "claim:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "claim.reversed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "claimId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "claim.reversed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reverse claim approval",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Claims"
          ],
          "publicNoun": "Claim",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "claim"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "claim.reversed",
            "operation": "claim.reverse",
            "operationId": "claim_reverse",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ClaimReverseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "claimId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^clm_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Claim instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.claimReverse({\n  path: {\n    claimId: \"clm_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "destination_account_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimReverseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "claimId": "clm_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "claim",
                      "status": "denied",
                      "fields": {
                        "policyId": "pol_sandbox_example0001",
                        "claimantAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "claimAmount": "1",
                        "currency": "SAR",
                        "peril": "customer_request",
                        "occurredAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections": {
      "get": {
        "operationId": "collection_list",
        "tags": [
          "collection"
        ],
        "summary": "List Collections",
        "description": "List Collections as a cursor-paginated page. The pay-in noun: money arriving from the outside world, tracked from the expected payment that declared it through to the account it credits.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collection.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "collection:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collection.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "collection",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Collections",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Collections"
          ],
          "publicNoun": "Collection",
          "resourceRef": "collection",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases": {
      "post": {
        "operationId": "collections_case_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Open a collections case",
        "description": "Opens the referral record for a delinquent exposure. Admission requires the agreement to be advanced and the triggering installment to be overdue AND to belong to that same agreement; one delinquent slice can open at most one case, ever. No money moves and the agency is not yet involved.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "collections_case:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "agreementId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "triggeringInstallmentId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "debtorAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "recoveryAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "collections_case.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Open a collections case",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.created",
            "operation": "collections_case.create",
            "operationId": "collections_case_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_lending00001\",\n    agreementId: \"cagr_sandbox_lending0001\",\n    triggeringInstallmentId: \"inst_sandbox_lending0003\",\n    debtorAccountId: \"acct_sandbox_borrower001\",\n    recoveryAccountId: \"acct_sandbox_pool000001\",\n    referredAmount: \"450000\",\n    currency: \"SAR\",\n    maxContactAttemptsPer30Days: 6,\n    allowedContactStartHour: 9,\n    allowedContactEndHour: 20,\n    memo: \"Third installment 45 days past due; dunning exhausted.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_already_claimed",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionsCaseCreateInput"
              },
              "examples": {
                "open_case_for_overdue_installment": {
                  "value": {
                    "workspaceId": "wsp_sandbox_lending00001",
                    "agreementId": "cagr_sandbox_lending0001",
                    "triggeringInstallmentId": "inst_sandbox_lending0003",
                    "debtorAccountId": "acct_sandbox_borrower001",
                    "recoveryAccountId": "acct_sandbox_pool000001",
                    "referredAmount": "450000",
                    "currency": "SAR",
                    "maxContactAttemptsPer30Days": 6,
                    "allowedContactStartHour": 9,
                    "allowedContactEndHour": 20,
                    "memo": "Third installment 45 days past due; dunning exhausted."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_lending00001",
                    "agreementId": "cagr_sandbox_lending0001",
                    "triggeringInstallmentId": "inst_sandbox_lending0003",
                    "debtorAccountId": "acct_sandbox_borrower001",
                    "recoveryAccountId": "acct_sandbox_pool000001",
                    "referredAmount": "450000",
                    "currency": "SAR",
                    "maxContactAttemptsPer30Days": 6,
                    "allowedContactStartHour": 9,
                    "allowedContactEndHour": 20,
                    "memo": "Third installment 45 days past due; dunning exhausted."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "opened",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_already_claimed, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_already_claimed",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "collections_case_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List collections cases",
        "description": "List collections cases",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "collections_case:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List collections cases",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "opened",
                "assigned",
                "recovered",
                "plan_agreed",
                "recalled",
                "returned_uncollected"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "agreementId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement this case collects against"
            }
          },
          {
            "name": "triggeringInstallmentId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Overdue installment whose delinquency opened this case"
            }
          },
          {
            "name": "debtorAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "recoveryAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "referredAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "referredAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"opened\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    agreementId: \"cagr_sandbox_example0001\",\n    triggeringInstallmentId: \"inst_sandbox_example0001\",\n    debtorAccountId: \"acct_sandbox_example0001\",\n    recoveryAccountId: \"acct_sandbox_example0001\",\n    referredAmountFrom: \"1\",\n    referredAmountTo: \"1\",\n    currency: \"SAR\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases/{collectionsCaseId}": {
      "get": {
        "operationId": "collections_case_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a collections case",
        "description": "Retrieve a collections case",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "collections_case:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a collections case",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseRetrieve({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "opened",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "collections_case_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a collections case",
        "description": "Edits the mutable fields of a collections case (memo) while it is opened or assigned. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "collections_case:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "collections_case.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a collections case",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.updated",
            "operation": "collections_case.update",
            "operationId": "collections_case_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseUpdate({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionsCaseUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "opened",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases/{collectionsCaseId}/agree-plan": {
      "post": {
        "operationId": "collections_case_agree_plan",
        "tags": [
          "noun_instance"
        ],
        "summary": "Record an agreed settlement plan",
        "description": "Closes the case on the agency's negotiated settlement plan, confirmed through the collections_agency seam. No money moves here: the plan's schedule rides the restructure grammar -- the creditor supersedes the agreement (credit_agreement.reschedule) and the successor's installments carry the collections, keeping the principal-cap invariant intact.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.agree_plan",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "collections_case:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.plan_agreed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "collections_case.plan_agreed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Record an agreed settlement plan",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.plan_agreed",
            "operation": "collections_case.agree_plan",
            "operationId": "collections_case_agree_plan",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseAgreePlanOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseAgreePlan({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseAgreePlanOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "plan_agreed",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_decision_declined, noun_decision_timeout, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases/{collectionsCaseId}/assign": {
      "post": {
        "operationId": "collections_case_assign",
        "tags": [
          "noun_instance"
        ],
        "summary": "Assign a collections case to an agency",
        "description": "Hands the case to the licensed collections agency: the agency answers a just-in-time accept/refuse through the collections_agency seam, receiving the referral with its contact caps as data. An unreachable agency declines by policy -- custody is never assumed. The agency's case reference lands as external-confirmation evidence on the receipt.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.assign",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "collections_case:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.assigned",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "collections_case.assigned"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Assign a collections case to an agency",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.assigned",
            "operation": "collections_case.assign",
            "operationId": "collections_case_assign",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseAssignOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseAssign({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseAssignOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "assigned",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_decision_declined, noun_decision_timeout, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases/{collectionsCaseId}/recall": {
      "post": {
        "operationId": "collections_case_recall",
        "tags": [
          "noun_instance"
        ],
        "summary": "Recall a collections case",
        "description": "Pulls the referral back to the creditor: before restructuring a delinquent agreement or switching agencies, the case is recalled first. Pure lifecycle transition; the agency is informed through the ordinary event fan-out.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.recall",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "collections_case:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.recalled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "collections_case.recalled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Recall a collections case",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.recalled",
            "operation": "collections_case.recall",
            "operationId": "collections_case_recall",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseRecallOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseRecall({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseRecallOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "recalled",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases/{collectionsCaseId}/recover": {
      "post": {
        "operationId": "collections_case_recover",
        "tags": [
          "noun_instance"
        ],
        "summary": "Record a lump-sum recovery",
        "description": "Closes the case with the agency's reported lump-sum recovery: settles the recovered amount from the debtor's account into the recovery account through an ordinary kernel transfer, gated on the agreement still being advanced and refused past the referred amount. The recovered amount persists on the case and reduces the agreement's outstanding balance at settlement. Partial-recovery streams are not recorded here -- a negotiated schedule is the plan path.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.recover",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "collections_case:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.recovered",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "collections_case.recovered"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Record a lump-sum recovery",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.recovered",
            "operation": "collections_case.recover",
            "operationId": "collections_case_recover",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseRecoverOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseRecover({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_lending001\",\n  },\n  body: {\n    recoveredAmount: \"180000\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_remainder_exceeded",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionsCaseRecoverBody"
              },
              "examples": {
                "record_lump_sum_recovery": {
                  "value": {
                    "recoveredAmount": "180000"
                  }
                },
                "default": {
                  "value": {
                    "recoveredAmount": "180000"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseRecoverOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "recovered",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, noun_remainder_exceeded, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_remainder_exceeded",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections-cases/{collectionsCaseId}/return-uncollected": {
      "post": {
        "operationId": "collections_case_return_uncollected",
        "tags": [
          "noun_instance"
        ],
        "summary": "Record a case returned uncollected",
        "description": "Closes the case as the honest failure path when the agency exhausts lawful contact and recovers nothing. The exposure itself is then written off through the agreement's own write_off grammar; nothing is clawed back here.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collections_case.return_uncollected",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "collections_case:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collections_case.returned_uncollected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionsCaseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "collections_case.returned_uncollected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Record a case returned uncollected",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Collections Cases"
          ],
          "publicNoun": "Collections case",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "collections_case"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collections_case.returned_uncollected",
            "operation": "collections_case.return_uncollected",
            "operationId": "collections_case_return_uncollected",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionsCaseReturnUncollectedOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionsCaseId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionsCaseReturnUncollected({\n  path: {\n    collectionsCaseId: \"ccase_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionsCaseReturnUncollectedOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionsCaseId": "ccase_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "collections_case",
                      "status": "returned_uncollected",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "triggeringInstallmentId": "inst_sandbox_example0001",
                        "debtorAccountId": "acct_sandbox_example0001",
                        "recoveryAccountId": "acct_sandbox_example0001",
                        "referredAmount": "1",
                        "currency": "SAR",
                        "maxContactAttemptsPer30Days": 0
                      },
                      "refs": {
                        "recoveryTransferId": "resource_sandbox_example0001",
                        "recoveredAmount": "40000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections/reserve": {
      "post": {
        "operationId": "collection_pay_in_reserve",
        "tags": [
          "collection"
        ],
        "summary": "Reserve a collection pay-in",
        "description": "Reserves an inbound pay-in by holding the amount on the destination account against the funding source, then authorizing the pull with the engine-selected downstream payment processor after commit. Provider identity is never caller-supplied, and the operation succeeds only after the authorization is bound to the exact reserve request. The pay-in is not settled until a later capture; a cancel releases the hold. A retry with the same Idempotency-Key returns the original reservation rather than placing a second hold.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collection.pay_in.reserve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger",
          "external_confirmation"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collection.pay_in.reserved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger",
            "external"
          ]
        },
        "x-hyperscale-external-confirmation-capability": "collection_payment",
        "x-hyperscale-external-confirmation-obligations": [
          {
            "kind": "collection_reserve",
            "required": true,
            "providerField": "provider",
            "providerReferenceField": "providerReference",
            "resourceIdPath": "collectionId",
            "resourceKind": "collection",
            "description": "The operation cannot succeed until its engine-selected payment processor authorization is recorded with exact request and resource proof.",
            "providerEgress": true
          }
        ],
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "collection",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sourceAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "destinationAccountId"
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "amountPath": "amount",
            "currencyPath": "currency",
            "deterministicTransferId": "operation",
            "lineage": "none",
            "sourceAccountIdPath": "sourceAccountId",
            "destinationAccountIdPath": "destinationAccountId",
            "transferSemantics": "reserve"
          },
          "metering": {},
          "audit": {
            "event": "collection.pay_in.reserved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy",
            "external confirmation obligation metadata"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests.",
            "Escalate missing, rejected, or conflicting External Confirmation."
          ],
          "externalProvider": true,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reserve a collection pay-in",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input.",
            "Refuse to claim external completion without matching External Confirmation."
          ],
          "receiptExpected": true,
          "risk": "external_provider",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Collections"
          ],
          "publicNoun": "Collection",
          "resourceRef": "collection",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collection.pay_in.reserved",
            "operation": "collection.pay_in.reserve",
            "operationId": "collection_pay_in_reserve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionPayInReserveOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionPayInReserve({\n  body: {\n    sourceAccountId: \"acct_sandbox_example0001\",\n    destinationAccountId: \"acct_sandbox_example0001\",\n    amount: \"1\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "external_confirmation_conflict",
          "external_confirmation_not_found",
          "external_confirmation_resource_conflict",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "provider_egress_failed",
          "provider_egress_rejected",
          "provider_outcome_unsupported",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionPayInReserveInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "sourceAccountId": "acct_sandbox_example0001",
                    "destinationAccountId": "acct_sandbox_example0001",
                    "amount": "1",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionPayInReserveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionId": "col_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "status": "reserved"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, provider_outcome_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "provider_outcome_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, external_confirmation_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "external_confirmation_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, external_confirmation_conflict, external_confirmation_resource_conflict, insufficient_balance, ledger_transfer_rejected, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "external_confirmation_conflict",
              "external_confirmation_resource_conflict",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Contract-declared domain errors: state_constraint_failed, provider_egress_rejected.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed",
              "provider_egress_rejected"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "502": {
            "description": "Contract-declared domain errors: provider_egress_failed.",
            "x-hyperscale-error-codes": [
              "provider_egress_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "provider_egress_failed",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections/{collectionId}": {
      "get": {
        "operationId": "collection_retrieve",
        "tags": [
          "collection"
        ],
        "summary": "Retrieve a Collection",
        "description": "Retrieve a single Collection by its collectionId. The pay-in noun: money arriving from the outside world, tracked from the expected payment that declared it through to the account it credits.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collection.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "collection:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collection.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "collection",
              "action": "read",
              "tenantScoped": true,
              "idPath": "collectionId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Collection",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Collections"
          ],
          "publicNoun": "Collection",
          "resourceRef": "collection",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "parameters": [
          {
            "name": "collectionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionRetrieve({\n  path: {\n    collectionId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "collectionId": "col_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections/{collectionId}/cancel": {
      "post": {
        "operationId": "collection_pay_in_cancel",
        "tags": [
          "collection"
        ],
        "summary": "Cancel a reserved collection pay-in",
        "description": "Cancels a still-reserved pay-in and releases the pending hold back on the destination account, voiding the authorization with the downstream payment processor after commit. Only a reserved collection can be cancelled; a captured collection has already settled.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collection.pay_in.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collection.pay_in.cancelled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "collection",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionId",
              "status": {
                "allowed": [
                  "reserved"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "deterministicTransferId": "resource_finalization",
            "lineage": "pending_transfer",
            "pendingTransferIdPath": "transferId",
            "transferSemantics": "void_pending"
          },
          "metering": {},
          "audit": {
            "event": "collection.pay_in.cancelled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a reserved collection pay-in",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Collections"
          ],
          "publicNoun": "Collection cancellation",
          "resourceRef": "collection",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collection.pay_in.cancelled",
            "operation": "collection.pay_in.cancel",
            "operationId": "collection_pay_in_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionPayInCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale collection ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionPayInCancel({\n  path: {\n    collectionId: \"col_sandbox_example0001\",\n  },\n  body: {\n    transferId: \"trn_sandbox_example0001\",\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "collection_authorization_unverified",
          "collection_not_found",
          "collection_status_forbidden",
          "collection_transfer_mismatch",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionPayInCancelBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "transferId": "trn_sandbox_example0001",
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionPayInCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionId": "col_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "status": "cancelled"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, collection_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "collection_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, collection_authorization_unverified, collection_status_forbidden, collection_transfer_mismatch, cross_tenant_transfer_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "collection_authorization_unverified",
              "collection_status_forbidden",
              "collection_transfer_mismatch",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/collections/{collectionId}/capture": {
      "post": {
        "operationId": "collection_pay_in_capture",
        "tags": [
          "collection"
        ],
        "summary": "Capture a reserved collection pay-in",
        "description": "Captures a reserved pay-in only after the engine-selected downstream payment processor returns a distinct acknowledgement for the exact capture request. That provider acceptance is durably recorded before ledger settlement dispatches the pending hold into a posted credit on the destination account. The collection must still be reserved; capturing an already-captured collection is rejected, and a retry with the same Idempotency-Key returns the settled result rather than pulling the funds twice.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "collection.pay_in.capture",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "external_confirmation",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "collection.pay_in.captured",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger",
            "external"
          ]
        },
        "x-hyperscale-external-confirmation-capability": "collection_payment",
        "x-hyperscale-external-confirmation-obligations": [
          {
            "kind": "collection_capture",
            "required": true,
            "providerField": "provider",
            "providerReferenceField": "providerReference",
            "resourceIdPath": "collectionId",
            "resourceKind": "collection",
            "description": "The engine-selected payment processor must return a distinct capture acknowledgement, which is durably bound to this exact capture before ledger settlement is dispatched.",
            "providerEgress": true
          }
        ],
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "collection",
              "action": "write",
              "tenantScoped": true,
              "idPath": "collectionId",
              "status": {
                "allowed": [
                  "reserved"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "deterministicTransferId": "resource_finalization",
            "lineage": "pending_transfer",
            "pendingTransferIdPath": "transferId",
            "transferSemantics": "post_pending"
          },
          "metering": {
            "meter": "collection.pay_in.count",
            "meters": [
              "collection.pay_in.count",
              "collection.pay_in.volume_sar"
            ]
          },
          "audit": {
            "event": "collection.pay_in.captured"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy",
            "external confirmation obligation metadata"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests.",
            "Escalate missing, rejected, or conflicting External Confirmation."
          ],
          "externalProvider": true,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Capture a reserved collection pay-in",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input.",
            "Refuse to claim external completion without matching External Confirmation."
          ],
          "receiptExpected": true,
          "risk": "external_provider",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Collections"
          ],
          "publicNoun": "Collection capture",
          "resourceRef": "collection",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "collection.pay_in.captured",
            "operation": "collection.pay_in.capture",
            "operationId": "collection_pay_in_capture",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CollectionPayInCaptureOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "collectionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^col_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale collection ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.collectionPayInCapture({\n  path: {\n    collectionId: \"col_sandbox_example0001\",\n  },\n  body: {\n    transferId: \"trn_sandbox_example0001\",\n    capturedAt: \"2026-01-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "collection_authorization_unverified",
          "collection_not_found",
          "collection_status_forbidden",
          "collection_transfer_mismatch",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "external_confirmation_conflict",
          "external_confirmation_not_found",
          "external_confirmation_resource_conflict",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "provider_egress_rejected",
          "provider_outcome_unsupported",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CollectionPayInCaptureBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "transferId": "trn_sandbox_example0001",
                    "capturedAt": "2026-01-01T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CollectionPayInCaptureOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "collectionId": "col_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "status": "captured"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, provider_outcome_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "provider_outcome_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, collection_not_found, customer_not_found, entity_not_found, external_confirmation_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "collection_not_found",
              "customer_not_found",
              "entity_not_found",
              "external_confirmation_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, collection_authorization_unverified, collection_status_forbidden, collection_transfer_mismatch, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, external_confirmation_conflict, external_confirmation_resource_conflict, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "collection_authorization_unverified",
              "collection_status_forbidden",
              "collection_transfer_mismatch",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "external_confirmation_conflict",
              "external_confirmation_resource_conflict",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Contract-declared domain errors: state_constraint_failed, provider_egress_rejected.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed",
              "provider_egress_rejected"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/consents": {
      "get": {
        "operationId": "consent_list",
        "tags": [
          "consent"
        ],
        "summary": "List Consents",
        "description": "List Consents as a cursor-paginated page. Product-scoped customer consent for provider data-sharing. Provider-mediated sharing requires active, unexpired consent that covers the target provider and data categories.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "consent.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "consent:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "consent.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "consent",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Consents",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Consents"
          ],
          "publicNoun": "Consent",
          "resourceRef": "consent",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "active",
                "expired",
                "revoked"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.consentList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"active\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/consents/{consentId}": {
      "get": {
        "operationId": "consent_retrieve",
        "tags": [
          "consent"
        ],
        "summary": "Retrieve a Consent",
        "description": "Retrieve a single Consent by its consentId. Product-scoped customer consent for provider data-sharing. Provider-mediated sharing requires active, unexpired consent that covers the target provider and data categories.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "consent.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "consent:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "consent.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "consent",
              "action": "read",
              "tenantScoped": true,
              "idPath": "consentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Consent",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Consents"
          ],
          "publicNoun": "Consent",
          "resourceRef": "consent",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "consentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.consentRetrieve({\n  path: {\n    consentId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "consentId": "cns_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/consents/{consentId}/revoke": {
      "post": {
        "operationId": "consent_revoke",
        "tags": [
          "consent"
        ],
        "summary": "Revoke provider data consent",
        "description": "Revokes an active consent immediately so provider-mediated sharing can no longer use the covered subject data under that consent.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "consent.revoke",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "consent:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "consent.revoked",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId",
              "status": {
                "allowed": [
                  "active"
                ]
              }
            },
            {
              "kind": "consent",
              "action": "write",
              "tenantScoped": true,
              "idPath": "consentId",
              "status": {
                "allowed": [
                  "active"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "consent.revoked"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Revoke provider data consent",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Verification",
            "Consent"
          ],
          "publicNoun": "Consent revocation",
          "resourceRef": "consent",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "consent.revoked",
            "operation": "consent.revoke",
            "operationId": "consent_revoke",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ConsentRevokeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "consentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cns_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale customer consent ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.consentRevoke({\n  path: {\n    consentId: \"cns_sandbox_example0001\",\n  },\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "consent_expired",
          "consent_not_active",
          "consent_not_found",
          "consent_revoked",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConsentRevokeBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentRevokeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "consentId": "cns_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "subjectKind": "customer",
                      "subjectId": "sbj_sandbox_example0001",
                      "status": "revoked",
                      "revokedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, consent_expired, consent_revoked, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "consent_expired",
              "consent_revoked",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, consent_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "consent_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, consent_not_active, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "consent_not_active",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/contact-attempts": {
      "post": {
        "operationId": "contact_attempt_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Record a contact attempt",
        "description": "Appends one debtor contact to the case's ledger. Admission requires the case to be assigned -- an attempt can only be evidence of agency activity while an agency actually holds the case. No money moves.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "contact_attempt.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "contact_attempt:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "contact_attempt.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "caseId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "contact_attempt.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Record a contact attempt",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Contact Attempts"
          ],
          "publicNoun": "Contact attempt",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "contact_attempt"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "contact_attempt.created",
            "operation": "contact_attempt.create",
            "operationId": "contact_attempt_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ContactAttemptCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.contactAttemptCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_lending00001\",\n    caseId: \"ccase_sandbox_lending001\",\n    channel: \"call\",\n    attemptedAt: \"2026-07-19T10:30:00.000Z\",\n    outcome: \"promise_to_pay\",\n    note: \"Debtor committed to a lump-sum payment within two weeks.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContactAttemptCreateInput"
              },
              "examples": {
                "record_call_with_promise_to_pay": {
                  "value": {
                    "workspaceId": "wsp_sandbox_lending00001",
                    "caseId": "ccase_sandbox_lending001",
                    "channel": "call",
                    "attemptedAt": "2026-07-19T10:30:00.000Z",
                    "outcome": "promise_to_pay",
                    "note": "Debtor committed to a lump-sum payment within two weeks."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_lending00001",
                    "caseId": "ccase_sandbox_lending001",
                    "channel": "call",
                    "attemptedAt": "2026-07-19T10:30:00.000Z",
                    "outcome": "promise_to_pay",
                    "note": "Debtor committed to a lump-sum payment within two weeks."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactAttemptCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "contactAttemptId": "catt_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "contact_attempt",
                      "status": "recorded",
                      "fields": {
                        "caseId": "ccase_sandbox_example0001",
                        "channel": "sms",
                        "attemptedAt": "2026-01-01T00:00:00.000Z",
                        "outcome": "reached"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "contact_attempt_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List contact attempts",
        "description": "List contact attempts",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "contact_attempt.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "contact_attempt:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "contact_attempt.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List contact attempts",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Contact Attempts"
          ],
          "publicNoun": "Contact attempt",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "contact_attempt"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "recorded",
                "voided"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "caseId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ccase_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collections case this attempt is ledgered under"
            }
          },
          {
            "name": "channel",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "sms",
                "email",
                "call",
                "letter"
              ]
            }
          },
          {
            "name": "attemptedAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "outcome",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "reached",
                "no_answer",
                "promise_to_pay"
              ]
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.contactAttemptList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"recorded\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    caseId: \"ccase_sandbox_example0001\",\n    channel: \"sms\",\n    attemptedAt: \"2026-01-01T00:00:00.000Z\",\n    outcome: \"reached\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactAttemptListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/contact-attempts/{contactAttemptId}": {
      "get": {
        "operationId": "contact_attempt_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a contact attempt",
        "description": "Retrieve a contact attempt",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "contact_attempt.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "contact_attempt:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "contact_attempt.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "contactAttemptId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a contact attempt",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Contact Attempts"
          ],
          "publicNoun": "Contact attempt",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "contact_attempt"
        ],
        "parameters": [
          {
            "name": "contactAttemptId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^catt_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Contact attempt instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.contactAttemptRetrieve({\n  path: {\n    contactAttemptId: \"catt_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactAttemptRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "contactAttemptId": "catt_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "contact_attempt",
                      "status": "recorded",
                      "fields": {
                        "caseId": "ccase_sandbox_example0001",
                        "channel": "sms",
                        "attemptedAt": "2026-01-01T00:00:00.000Z",
                        "outcome": "reached"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/contact-attempts/{contactAttemptId}/void": {
      "post": {
        "operationId": "contact_attempt_void",
        "tags": [
          "noun_instance"
        ],
        "summary": "Void a contact attempt",
        "description": "Marks a mis-recorded attempt void. The row stays in the ledger as its own receipted correction -- append-only evidence is never deleted or mutated.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "contact_attempt.void",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "contact_attempt:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "contact_attempt.voided",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "contactAttemptId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "contact_attempt.voided"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Void a contact attempt",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Contact Attempts"
          ],
          "publicNoun": "Contact attempt",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "contact_attempt"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "contact_attempt.voided",
            "operation": "contact_attempt.void",
            "operationId": "contact_attempt_void",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ContactAttemptVoidOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "contactAttemptId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^catt_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Contact attempt instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.contactAttemptVoid({\n  path: {\n    contactAttemptId: \"catt_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactAttemptVoidOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "contactAttemptId": "catt_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "contact_attempt",
                      "status": "voided",
                      "fields": {
                        "caseId": "ccase_sandbox_example0001",
                        "channel": "sms",
                        "attemptedAt": "2026-01-01T00:00:00.000Z",
                        "outcome": "reached"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements": {
      "post": {
        "operationId": "credit_agreement_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a credit agreement",
        "description": "Opens the agreement as a record of the exposure to come. The borrower and lending pool accounts are caller-supplied; no money moves until the advance. An agreement linking an exposure arrangement is only admitted while the arrangement is approved, belongs to the same borrower in the same currency, and has approved-amounts headroom for the principal.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "credit_agreement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "borrowerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "supersedesAgreementId",
              "optional": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "exposureArrangementId",
              "optional": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingRoundId",
              "optional": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "credit_agreement.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.created",
            "operation": "credit_agreement.create",
            "operationId": "credit_agreement_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    fundingAccountId: \"acct_sandbox_example0001\",\n    principal: \"1\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditAgreementCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "borrowerAccountId": "acct_sandbox_example0001",
                    "fundingAccountId": "acct_sandbox_example0001",
                    "principal": "1",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "created",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "credit_agreement_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List credit agreements",
        "description": "List credit agreements",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "credit_agreement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List credit agreements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "advanced",
                "settled",
                "written_off",
                "closed_rescheduled",
                "closed_refinanced"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "borrowerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "fundingAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "principalFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "principalTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "supersedesAgreementId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Closed credit agreement this one supersedes"
            }
          },
          {
            "name": "exposureArrangementId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Exposure arrangement whose caps bound this agreement"
            }
          },
          {
            "name": "fundingRoundId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Funding round whose collected pledges fund this agreement"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    fundingAccountId: \"acct_sandbox_example0001\",\n    principalFrom: \"1\",\n    principalTo: \"1\",\n    currency: \"SAR\",\n    supersedesAgreementId: \"cagr_sandbox_example0001\",\n    exposureArrangementId: \"earr_sandbox_example0001\",\n    fundingRoundId: \"fnr_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements/{creditAgreementId}": {
      "get": {
        "operationId": "credit_agreement_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a credit agreement",
        "description": "Retrieve a credit agreement",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "credit_agreement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a credit agreement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementRetrieve({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "created",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "credit_agreement_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a credit agreement",
        "description": "Edits the mutable fields of a credit agreement (memo) while it is created or advanced. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "credit_agreement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "credit_agreement.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.updated",
            "operation": "credit_agreement.update",
            "operationId": "credit_agreement_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementUpdate({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditAgreementUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "created",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements/{creditAgreementId}/advance": {
      "post": {
        "operationId": "credit_agreement_advance",
        "tags": [
          "noun_instance"
        ],
        "summary": "Advance a credit agreement",
        "description": "Draws down the principal from the lending pool account into the borrower's account, opening or growing the exposure: the full remaining principal by default, or the caller's partial amount, refused past the remaining headroom. The downstream financier answers a just-in-time funding decision through the credit_servicing seam before the money moves; an unreachable financier declines by policy. Under an exposure arrangement the advance also refuses while the arrangement is not approved or the disbursement would push the outstanding total past its cap. From here the installments scheduled against the agreement carry the collection.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.advance",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "credit_agreement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.advanced",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "credit_agreement.advanced"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Advance a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.advanced",
            "operation": "credit_agreement.advance",
            "operationId": "credit_agreement_advance",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementAdvanceOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementAdvance({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "exposure_cap_exceeded",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_remainder_exceeded",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditAgreementAdvanceBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementAdvanceOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "advanced",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, exposure_cap_exceeded, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, noun_reference_required, noun_reference_status_forbidden, noun_remainder_exceeded, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "exposure_cap_exceeded",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_remainder_exceeded",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements/{creditAgreementId}/refinance": {
      "post": {
        "operationId": "credit_agreement_refinance",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refinance a credit agreement",
        "description": "Closes the agreement as superseded by a refinanced successor: new terms, optionally topped-up principal. Carried dues are explicitly capitalized or written off, and the top-up disburses through the successor's own advance, so this transition itself moves no money.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.refinance",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "credit_agreement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.refinanced",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "credit_agreement.refinanced"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refinance a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.refinanced",
            "operation": "credit_agreement.refinance",
            "operationId": "credit_agreement_refinance",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementRefinanceOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementRefinance({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n  body: {\n    carriedDues: \"capitalized\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditAgreementRefinanceBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "carriedDues": "capitalized"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementRefinanceOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "closed_refinanced",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_decision_declined, noun_decision_timeout, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements/{creditAgreementId}/reschedule": {
      "post": {
        "operationId": "credit_agreement_reschedule",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reschedule a credit agreement",
        "description": "Closes the agreement as superseded by a rescheduled successor: same exposure, new schedule. Carried dues are explicitly capitalized into the successor's principal or written off, never silent. No money moves here; the successor agreement's own advance carries any disbursement, and the note swap releases the old sanad series for the successor's new one.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.reschedule",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "credit_agreement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.rescheduled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "credit_agreement.rescheduled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reschedule a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.rescheduled",
            "operation": "credit_agreement.reschedule",
            "operationId": "credit_agreement_reschedule",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementRescheduleOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementReschedule({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n  body: {\n    carriedDues: \"capitalized\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreditAgreementRescheduleBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "carriedDues": "capitalized"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementRescheduleOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "closed_rescheduled",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_decision_declined, noun_decision_timeout, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements/{creditAgreementId}/settle": {
      "post": {
        "operationId": "credit_agreement_settle",
        "tags": [
          "noun_instance"
        ],
        "summary": "Settle a credit agreement",
        "description": "Closes the agreement by collecting its outstanding remainder -- everything advanced minus everything already repaid or forgiven -- from the borrower's account back into the lending pool, atomically with the status transition, refused when the borrower's account cannot cover it. Collected installments, written-off installments (the write-off promise wins: a forgiven slice stays with the borrower and is never clawed back here), and collections-case recoveries all count as repaid. When nothing is outstanding the close is a pure lifecycle transition. Should installment collections and agency recoveries together ever exceed the advanced total -- the borrower genuinely over-paid through two channels -- settlement refuses as over-collected and keeps refusing; the exit for such an agreement is write_off.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.settle",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "credit_agreement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.settled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "credit_agreement.settled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Settle a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.settled",
            "operation": "credit_agreement.settle",
            "operationId": "credit_agreement_settle",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementSettleOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementSettle({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_remainder_exceeded",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementSettleOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "settled",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_remainder_exceeded, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_remainder_exceeded",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-agreements/{creditAgreementId}/write-off": {
      "post": {
        "operationId": "credit_agreement_write_off",
        "tags": [
          "noun_instance"
        ],
        "summary": "Write off a credit agreement",
        "description": "Closes the agreement as a loss when collection has failed. The advanced principal stays with the borrower; no clawback moves here, making this the honest loss path.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_agreement.write_off",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "credit_agreement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_agreement.written_off",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "credit_agreement.written_off"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Write off a credit agreement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Credit Agreements"
          ],
          "publicNoun": "Credit agreement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "credit_agreement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "credit_agreement.written_off",
            "operation": "credit_agreement.write_off",
            "operationId": "credit_agreement_write_off",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CreditAgreementWriteOffOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "creditAgreementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditAgreementWriteOff({\n  path: {\n    creditAgreementId: \"cagr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditAgreementWriteOffOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "creditAgreementId": "cagr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "credit_agreement",
                      "status": "written_off",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "principal": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "advanceTransferId": "resource_sandbox_example0001",
                        "settleTransferId": "resource_sandbox_example0001",
                        "advanceAmount": "40000",
                        "advancedTotal": "90000",
                        "settleAmount": "60000"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-balances": {
      "get": {
        "operationId": "credit_balance_list",
        "tags": [
          "credit_balance"
        ],
        "summary": "List Credit balances",
        "description": "List Credit balances as a cursor-paginated page. A customer's running credit position in one currency. Grants add to it, ledger entries move it, and invoices draw it down before charging.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_balance.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_balance.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_balance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Credit balances",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Credits"
          ],
          "publicNoun": "Credit balance",
          "resourceRef": "credit_balance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditBalanceList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditBalanceListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-balances/{creditBalanceId}": {
      "get": {
        "operationId": "credit_balance_retrieve",
        "tags": [
          "credit_balance"
        ],
        "summary": "Retrieve a Credit balance",
        "description": "Retrieve a single Credit balance by its creditBalanceId. A customer's running credit position in one currency. Grants add to it, ledger entries move it, and invoices draw it down before charging.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_balance.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_balance.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_balance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditBalanceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Credit balance",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Credits"
          ],
          "publicNoun": "Credit balance",
          "resourceRef": "credit_balance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "creditBalanceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditBalanceRetrieve({\n  path: {\n    creditBalanceId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditBalanceRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "creditBalanceId": "cbal_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-grants": {
      "get": {
        "operationId": "credit_grant_list",
        "tags": [
          "credit_grant"
        ],
        "summary": "List Credit grants",
        "description": "List Credit grants as a cursor-paginated page. A block of credit issued to a customer, tracked from its original amount down to the amount still remaining as invoices consume it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_grant.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_grant.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_grant",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Credit grants",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Credits"
          ],
          "publicNoun": "Credit grant",
          "resourceRef": "credit_grant",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditGrantList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditGrantListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-grants/{creditGrantId}": {
      "get": {
        "operationId": "credit_grant_retrieve",
        "tags": [
          "credit_grant"
        ],
        "summary": "Retrieve a Credit grant",
        "description": "Retrieve a single Credit grant by its creditGrantId. A block of credit issued to a customer, tracked from its original amount down to the amount still remaining as invoices consume it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_grant.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_grant.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_grant",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditGrantId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Credit grant",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Credits"
          ],
          "publicNoun": "Credit grant",
          "resourceRef": "credit_grant",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "creditGrantId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditGrantRetrieve({\n  path: {\n    creditGrantId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditGrantRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "creditGrantId": "cgr_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-ledger-entries": {
      "get": {
        "operationId": "credit_ledger_entry_list",
        "tags": [
          "credit_ledger_entry"
        ],
        "summary": "List Credit ledger",
        "description": "List Credit ledger as a cursor-paginated page. One movement of credit: the grant it came from, the invoice that consumed it, the direction and amount, and the balance left after. These entries are the working behind every credit balance.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_ledger_entry.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_ledger_entry.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_ledger_entry",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Credit ledger",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Credits"
          ],
          "publicNoun": "Credit ledger entry",
          "resourceRef": "credit_ledger_entry",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditLedgerEntryList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditLedgerEntryListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-ledger-entries/{creditLedgerEntryId}": {
      "get": {
        "operationId": "credit_ledger_entry_retrieve",
        "tags": [
          "credit_ledger_entry"
        ],
        "summary": "Retrieve a Credit ledger entry",
        "description": "Retrieve a single Credit ledger entry by its creditLedgerEntryId. One movement of credit: the grant it came from, the invoice that consumed it, the direction and amount, and the balance left after. These entries are the working behind every credit balance.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_ledger_entry.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_ledger_entry.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_ledger_entry",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditLedgerEntryId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Credit ledger entry",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Credits"
          ],
          "publicNoun": "Credit ledger entry",
          "resourceRef": "credit_ledger_entry",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "creditLedgerEntryId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditLedgerEntryRetrieve({\n  path: {\n    creditLedgerEntryId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditLedgerEntryRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "creditLedgerEntryId": "cled_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-note-lines": {
      "get": {
        "operationId": "credit_note_line_list",
        "tags": [
          "credit_note_line"
        ],
        "summary": "List Credit note lines",
        "description": "List Credit note lines as a cursor-paginated page. One line of a credit note, bound to the invoice line it reverses and carrying the amount reversed.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_note_line.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_note_line.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_note_line",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Credit note lines",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Credit note line",
          "resourceRef": "credit_note_line",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditNoteLineList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditNoteLineListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-note-lines/{creditNoteLineId}": {
      "get": {
        "operationId": "credit_note_line_retrieve",
        "tags": [
          "credit_note_line"
        ],
        "summary": "Retrieve a Credit note line",
        "description": "Retrieve a single Credit note line by its creditNoteLineId. One line of a credit note, bound to the invoice line it reverses and carrying the amount reversed.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_note_line.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_note_line.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_note_line",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditNoteLineId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Credit note line",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Credit note line",
          "resourceRef": "credit_note_line",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "creditNoteLineId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditNoteLineRetrieve({\n  path: {\n    creditNoteLineId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditNoteLineRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "creditNoteLineId": "cnl_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-notes": {
      "get": {
        "operationId": "credit_note_list",
        "tags": [
          "credit_note"
        ],
        "summary": "List Credit notes",
        "description": "List Credit notes as a cursor-paginated page. A document that reverses part or all of a finalized invoice. Issuing one never edits the invoice; it records the offsetting amount against it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_note.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_note.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_note",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Credit notes",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Credit note",
          "resourceRef": "credit_note",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "issued"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditNoteList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"issued\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditNoteListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/credit-notes/{creditNoteId}": {
      "get": {
        "operationId": "credit_note_retrieve",
        "tags": [
          "credit_note"
        ],
        "summary": "Retrieve a Credit note",
        "description": "Retrieve a single Credit note by its creditNoteId. A document that reverses part or all of a finalized invoice. Issuing one never edits the invoice; it records the offsetting amount against it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "credit_note.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "credit_note.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "credit_note",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditNoteId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Credit note",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Credit note",
          "resourceRef": "credit_note",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "creditNoteId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.creditNoteRetrieve({\n  path: {\n    creditNoteId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreditNoteRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "creditNoteId": "cnote_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-access": {
      "get": {
        "operationId": "customer_access_list",
        "tags": [
          "customer_access"
        ],
        "summary": "List Customer accesses",
        "description": "List Customer accesses as a cursor-paginated page. The grant that lets one customer use one Product. The customer credential spans the company, so this row is what makes it usable on a specific Product.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer_access.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer_access.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer_access",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Customer accesses",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers"
          ],
          "publicNoun": "Customer access",
          "resourceRef": "customer_access",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "active",
                "suspended",
                "closed"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerAccessList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"pending\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerAccessListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-access/{customerAccessId}": {
      "get": {
        "operationId": "customer_access_retrieve",
        "tags": [
          "customer_access"
        ],
        "summary": "Retrieve a Customer access",
        "description": "Retrieve a single Customer access by its customerAccessId. The grant that lets one customer use one Product. The customer credential spans the company, so this row is what makes it usable on a specific Product.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer_access.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer_access.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer_access",
              "action": "read",
              "tenantScoped": true,
              "idPath": "customerAccessId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Customer access",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers"
          ],
          "publicNoun": "Customer access",
          "resourceRef": "customer_access",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "name": "customerAccessId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerAccessRetrieve({\n  path: {\n    customerAccessId: \"cacc_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerAccessRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "customerAccessId": "cacc_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-access/{customerAccessId}/close": {
      "post": {
        "operationId": "customer_access_close",
        "tags": [
          "customer_access"
        ],
        "summary": "Close customer access",
        "description": "Moves a pending, active, or suspended product customer-access binding to closed status without disabling the tenant customer relationship or deleting binding history.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer_access.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "customer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer_access.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer_access",
              "action": "write",
              "tenantScoped": true,
              "idPath": "customerAccessId",
              "status": {
                "allowed": [
                  "pending",
                  "active",
                  "suspended"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer_access.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Close customer access",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Access"
          ],
          "publicNoun": "Customer access closure",
          "resourceRef": "customer_access",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "customer_access.closed",
            "operation": "customer_access.close",
            "operationId": "customer_access_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CustomerAccessCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "customerAccessId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale customer access ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerAccessClose({\n  path: {\n    customerAccessId: \"cacc_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "customer_access_lifecycle_status_forbidden",
          "customer_access_not_found",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_environment_invalid",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerAccessCloseBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerAccessCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "customerId": "cus_sandbox_example0001",
                      "customerAccessId": "cacc_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "pending",
                      "status": "closed"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_access_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_access_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_lifecycle_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_lifecycle_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-access/{customerAccessId}/reactivate": {
      "post": {
        "operationId": "customer_access_reactivate",
        "tags": [
          "customer_access"
        ],
        "summary": "Reactivate customer access",
        "description": "Restores a suspended product customer-access binding to active status. Closed bindings stay closed; compliance evidence captured at activation is left untouched.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer_access.reactivate",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "customer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer_access.reactivated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer_access",
              "action": "write",
              "tenantScoped": true,
              "idPath": "customerAccessId",
              "status": {
                "allowed": [
                  "suspended"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer_access.reactivated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reactivate customer access",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Access"
          ],
          "publicNoun": "Customer access reactivation",
          "resourceRef": "customer_access",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "customer_access.reactivated",
            "operation": "customer_access.reactivate",
            "operationId": "customer_access_reactivate",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CustomerAccessReactivateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "customerAccessId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale customer access ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerAccessReactivate({\n  path: {\n    customerAccessId: \"cacc_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "customer_access_lifecycle_status_forbidden",
          "customer_access_not_found",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerAccessReactivateBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerAccessReactivateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "customerId": "cus_sandbox_example0001",
                      "customerAccessId": "cacc_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "suspended",
                      "status": "active"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_access_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_access_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_lifecycle_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_lifecycle_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-access/{customerAccessId}/suspend": {
      "post": {
        "operationId": "customer_access_suspend",
        "tags": [
          "customer_access"
        ],
        "summary": "Suspend customer access",
        "description": "Moves an active product customer-access binding to suspended status without disabling the tenant customer relationship or mutating ledger state.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer_access.suspend",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "customer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer_access.suspended",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer_access",
              "action": "write",
              "tenantScoped": true,
              "idPath": "customerAccessId",
              "status": {
                "allowed": [
                  "active"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer_access.suspended"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Suspend customer access",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Access"
          ],
          "publicNoun": "Customer access suspension",
          "resourceRef": "customer_access",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "customer_access.suspended",
            "operation": "customer_access.suspend",
            "operationId": "customer_access_suspend",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CustomerAccessSuspendOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "customerAccessId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale customer access ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerAccessSuspend({\n  path: {\n    customerAccessId: \"cacc_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "customer_access_lifecycle_status_forbidden",
          "customer_access_not_found",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_environment_invalid",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerAccessSuspendBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerAccessSuspendOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "customerId": "cus_sandbox_example0001",
                      "customerAccessId": "cacc_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "active",
                      "status": "suspended"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_access_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_access_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_lifecycle_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_lifecycle_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-identity/login": {
      "post": {
        "operationId": "customer_login",
        "tags": [
          "customer"
        ],
        "summary": "Log in an end customer to a product",
        "description": "Verifies an end customer's password against the company's own customer credentials and mints a session bound to the named Product. The lookup is by email within the company, so the same address at two companies is two unrelated customers by design. A customer with no enrollment in that Product cannot sign in to it, and a suspended or closed enrollment is refused; a pending one succeeds, because completing verification is something the customer does while signed in. The session token is a one-time secret surfaced only in this response, never in receipts or replays.",
        "security": [],
        "x-hyperscale-operation": "customer.login",
        "x-hyperscale-audiences": [
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.logged_in",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "public",
          "tenant": {
            "mode": "none"
          },
          "resources": [
            {
              "kind": "customer_session",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer.logged_in",
            "audiences": []
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Log in an end customer to a product",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Never echo, log, or persist the returned secret/key; deliver it to the operator through the product surface."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": true
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Log in"
          ],
          "publicNoun": "Customer login",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerLogin({\n  body: {\n    workspaceId: \"wsp_sandbox_riyadhresale01\",\n    email: \"aisha@example.com\",\n    password: \"correct-horse-battery\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "customer_access_required",
          "customer_access_status_forbidden",
          "customer_not_found",
          "invalid_credentials",
          "operation_not_finalized",
          "workspace_not_found"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerLoginInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_riyadhresale01",
                    "email": "aisha@example.com",
                    "password": "correct-horse-battery"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerLoginOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_riyadhresale01",
                      "environment": "sandbox",
                      "customerId": "cus_sandbox_aisha0001",
                      "entityId": "ent_sandbox_aisha0001",
                      "email": "aisha@example.com",
                      "customerAccessId": "cacc_sandbox_aisha0001",
                      "customerAccessStatus": "pending",
                      "customerSessionId": "csess_sandbox_aisha0001",
                      "sessionToken": "hyperscale_cust_00000000000000000000000000000001",
                      "sessionExpiresAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials.",
            "x-hyperscale-error-codes": [
              "invalid_credentials"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-identity/logout": {
      "post": {
        "operationId": "customer_logout",
        "tags": [
          "customer"
        ],
        "summary": "Log out the current end-customer session",
        "description": "Revokes the session that made this request. The session names itself: there is no id in the body, so a shopper can only ever end their own sign-in. Once revoked the token can no longer authenticate.",
        "security": [
          {
            "CustomerSessionAuth": []
          }
        ],
        "x-hyperscale-operation": "customer.logout",
        "x-hyperscale-audiences": [
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.logged_out",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "customer_session",
          "tenant": {
            "mode": "none"
          },
          "resources": [
            {
              "kind": "customer_session",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer.logged_out",
            "audiences": []
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Log out the current end-customer session",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Log out"
          ],
          "publicNoun": "Customer logout",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerLogout({});"
          }
        ],
        "x-hyperscale-errors": [
          "operation_not_finalized",
          "session_required"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerLogoutOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "customerSessionId": "csess_sandbox_aisha0001",
                      "status": "revoked",
                      "revokedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: session_required.",
            "x-hyperscale-error-codes": [
              "session_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "session_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-identity/sessions/{customerSessionId}/revoke": {
      "post": {
        "operationId": "customer_session_revoke",
        "tags": [
          "customer"
        ],
        "summary": "Revoke one of the calling end customer's sessions",
        "description": "Revokes a single session belonging to the end customer making the request -- the sign-in on the phone they lost, ended from the laptop they still have. A session id that belongs to anyone else is not found rather than refused, so the operation cannot be used to discover that a session exists. Idempotent: revoking an already-revoked session succeeds with status already_revoked.",
        "security": [
          {
            "CustomerSessionAuth": []
          }
        ],
        "x-hyperscale-operation": "customer.session.revoke",
        "x-hyperscale-audiences": [
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.session.revoked",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "customer_session",
          "tenant": {
            "mode": "none"
          },
          "resources": [
            {
              "kind": "customer_session",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer.session.revoked"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Revoke one of the calling end customer's sessions",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Sessions"
          ],
          "publicNoun": "Customer session revocation",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "customer.session.revoked",
            "operation": "customer.session.revoke",
            "operationId": "customer_session_revoke",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CustomerSessionRevokeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "customerSessionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^csess_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale end-customer session ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerSessionRevoke({\n  path: {\n    customerSessionId: \"csess_sandbox_aisha0002\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "operation_not_finalized",
          "session_not_found",
          "session_required"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerSessionRevokeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "customerSessionId": "csess_sandbox_aisha0002",
                      "status": "revoked",
                      "revokedAt": "2026-01-02T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: session_required.",
            "x-hyperscale-error-codes": [
              "session_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "session_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, session_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "session_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customer-identity/signup": {
      "post": {
        "operationId": "customer_signup",
        "tags": [
          "customer"
        ],
        "summary": "Sign up an end customer for a product",
        "description": "Creates an end customer's own login for one company: the credential, the underlying legal entity, the customer, and a pending enrollment in the named Product, then signs them in. The entity starts pending and the enrollment starts pending, exactly as customer.create leaves them -- verification is the customer's own act, never a side effect of signing up. No account is created and no money can move until the entity clears and the enrollment is activated. The email is the login handle and is unique per company, so the same person shopping two of a company's products is one customer with one password. The session token is a one-time secret surfaced only in this response, never in receipts or replays.",
        "security": [],
        "x-hyperscale-operation": "customer.signup",
        "x-hyperscale-audiences": [
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.signed_up",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "public",
          "tenant": {
            "mode": "none"
          },
          "resources": [
            {
              "kind": "entity",
              "action": "create",
              "tenantScoped": false
            },
            {
              "kind": "customer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "customer_access",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "customer_session",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer.signed_up"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Sign up an end customer for a product",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Never echo, log, or persist the returned secret/key; deliver it to the operator through the product surface."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": true
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Sign up"
          ],
          "publicNoun": "Customer signup",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "customer.signed_up",
            "operation": "customer.signup",
            "operationId": "customer_signup",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CustomerSignupOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerSignup({\n  body: {\n    workspaceId: \"wsp_sandbox_riyadhresale01\",\n    email: \"aisha@example.com\",\n    password: \"correct-horse-battery\",\n    displayName: \"Aisha Al Saud\",\n    country: \"SA\",\n    termsAccepted: true,\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "operation_not_finalized",
          "workspace_not_found"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerSignupInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_riyadhresale01",
                    "email": "aisha@example.com",
                    "password": "correct-horse-battery",
                    "displayName": "Aisha Al Saud",
                    "country": "SA",
                    "termsAccepted": true
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerSignupOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_riyadhresale01",
                      "environment": "sandbox",
                      "customerId": "cus_sandbox_aisha0001",
                      "entityId": "ent_sandbox_aisha0001",
                      "email": "aisha@example.com",
                      "customerAccessId": "cacc_sandbox_aisha0001",
                      "customerAccessStatus": "pending",
                      "customerSessionId": "csess_sandbox_aisha0001",
                      "sessionToken": "hyperscale_cust_00000000000000000000000000000001",
                      "sessionExpiresAt": "2026-01-01T00:00:00.000Z",
                      "displayName": "Aisha Al Saud",
                      "customerStatus": "active",
                      "entityStatus": "pending"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials.",
            "x-hyperscale-error-codes": [
              "invalid_credentials"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customers": {
      "post": {
        "operationId": "customer_create",
        "tags": [
          "customer"
        ],
        "summary": "Create a customer",
        "description": "Creates a customer in one exact Product together with the underlying legal entity, capturing the entity kind, display name, and country of registration. The customer starts active; the entity always starts pending (unverified), and the Product access binding starts pending. Accounts and money movement stay refused until kind-appropriate entity clearance and access activation: person KYC or organization KYB in both environments, plus product activation review in live.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer.create",
        "x-hyperscale-audiences": [
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "customer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 20
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "entity",
              "action": "create",
              "tenantScoped": false
            },
            {
              "kind": "customer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "customer_access",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "customer.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a customer",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers"
          ],
          "publicNoun": "Customer",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "customer.created",
            "operation": "customer.create",
            "operationId": "customer_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/CustomerCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_riyadhresale01\",\n    entity: {\n      kind: \"person\",\n      displayName: \"Aisha Al Saud\",\n      country: \"SA\",\n    },\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "operation_not_finalized"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerCreateInput"
              },
              "examples": {
                "customer": {
                  "value": {
                    "workspaceId": "wsp_sandbox_riyadhresale01",
                    "entity": {
                      "kind": "person",
                      "displayName": "Aisha Al Saud",
                      "country": "SA"
                    }
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_riyadhresale01",
                    "entity": {
                      "kind": "person",
                      "displayName": "Aisha Al Saud",
                      "country": "SA"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerCreateOutput"
                },
                "examples": {
                  "customer": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_riyadhresale01",
                      "customerId": "cus_sandbox_aisha0001",
                      "customerStatus": "active",
                      "entityId": "ent_sandbox_aisha0001",
                      "entityStatus": "pending",
                      "customerAccessId": "cacc_sandbox_aisha0001"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials.",
            "x-hyperscale-error-codes": [
              "invalid_credentials"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_status_forbidden, entity_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_status_forbidden",
              "entity_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "customer_list",
        "tags": [
          "customer"
        ],
        "summary": "List Customers",
        "description": "List Customers as a cursor-paginated page. An end customer of a Product, the person or business a Team serves. Identity facts live on the linked entity; this row carries the Product-facing display name, external reference, and status.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "customer:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Customers",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers"
          ],
          "publicNoun": "Customer",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "active",
                "disabled",
                "erased"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"pending\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/customers/{customerId}": {
      "get": {
        "operationId": "customer_retrieve",
        "tags": [
          "customer"
        ],
        "summary": "Retrieve a Customer",
        "description": "Retrieve a single Customer by its customerId. An end customer of a Product, the person or business a Team serves. Identity facts live on the linked entity; this row carries the Product-facing display name, external reference, and status.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "customer.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "customer:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "customer.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer",
              "action": "read",
              "tenantScoped": true,
              "idPath": "customerId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Customer",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers"
          ],
          "publicNoun": "Customer",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.customerRetrieve({\n  path: {\n    customerId: \"cus_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "customerId": "cus_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "displayName": "Aisha Al Saud"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/deposits": {
      "get": {
        "operationId": "deposit_list",
        "tags": [
          "deposit"
        ],
        "summary": "List Deposits",
        "description": "List Deposits as a cursor-paginated page. Money received from outside Hyperscale after it has been attributed to a financial address and account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "deposit.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "deposit:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "deposit.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "deposit",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Deposits",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Deposits"
          ],
          "publicNoun": "Deposit",
          "resourceRef": "deposit",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "received",
                "returned"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.depositList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"received\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DepositListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/deposits/{depositId}": {
      "get": {
        "operationId": "deposit_retrieve",
        "tags": [
          "deposit"
        ],
        "summary": "Retrieve a Deposit",
        "description": "Retrieve a single Deposit by its depositId. Money received from outside Hyperscale after it has been attributed to a financial address and account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "deposit.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "deposit:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "deposit.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "deposit",
              "action": "read",
              "tenantScoped": true,
              "idPath": "depositId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Deposit",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Deposits"
          ],
          "publicNoun": "Deposit",
          "resourceRef": "deposit",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "parameters": [
          {
            "name": "depositId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.depositRetrieve({\n  path: {\n    depositId: \"dep_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DepositRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "depositId": "dep_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/developer-logs": {
      "get": {
        "operationId": "developer_log_list",
        "tags": [
          "developer_log"
        ],
        "summary": "List developer logs",
        "description": "List developer logs",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "developer.log.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "operation:read",
          "receipt:read",
          "audit:read",
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "developer.log.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "operation",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "receipt",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "audit",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "usage",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List developer logs",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Logs"
          ],
          "publicNoun": "Developer log",
          "viewId": "developer_log",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "operation",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "accepted",
                "pending",
                "succeeded",
                "failed"
              ]
            }
          },
          {
            "name": "resourceKind",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "account",
                "financial_address",
                "api_key",
                "audit",
                "workspace_capability",
                "charge",
                "collection",
                "consent",
                "credit_balance",
                "credit_grant",
                "credit_ledger_entry",
                "credit_note",
                "credit_note_line",
                "customer",
                "beneficiary",
                "deposit",
                "entity",
                "entity_kyc_profile",
                "expected_payment",
                "noun_instance",
                "operation",
                "payout",
                "beneficiary_verification",
                "workspace",
                "customer_access",
                "customer_session",
                "external_confirmation",
                "provider_cost_event",
                "provider_webhook_event",
                "webhook_endpoint",
                "webhook_delivery",
                "receipt",
                "tenant",
                "subject",
                "subject_kind",
                "statement_line",
                "reconciliation_run",
                "reconciliation_break",
                "reporting_artifact",
                "str_case",
                "wedged_money_repair",
                "reconciliation_break_repair",
                "attribution_queue",
                "user_session",
                "internal_transfer",
                "usage",
                "billing_adjustment",
                "meter_rate_discount",
                "platform_alert",
                "platform_rate_override",
                "billing_period",
                "billing_subscription",
                "invoice",
                "invoice_line",
                "meter_period_snapshot",
                "trust_review",
                "trust_evidence",
                "trust_requirement",
                "trust_review_subject",
                "support_ticket",
                "support_ticket_message",
                "support_booking",
                "support_plan_selection",
                "tenant_bank_connection"
              ]
            }
          },
          {
            "name": "resourceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "principalId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^prn_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale principal ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.developerLogList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    operation: \"account.create\",\n    status: \"accepted\",\n    resourceKind: \"account\",\n    resourceId: \"resource_sandbox_example0001\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    principalId: \"prn_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeveloperLogListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/developer-logs/{operationId}": {
      "get": {
        "operationId": "developer_log_retrieve",
        "tags": [
          "developer_log"
        ],
        "summary": "Retrieve a developer log",
        "description": "Retrieve a developer log",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "developer.log.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "operation:read",
          "receipt:read",
          "audit:read",
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "developer.log.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "operation",
              "action": "read",
              "tenantScoped": true,
              "idPath": "operationId"
            },
            {
              "kind": "receipt",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "audit",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "usage",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a developer log",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Logs"
          ],
          "publicNoun": "Developer log",
          "viewId": "developer_log",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "operationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ops_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale operation ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.developerLogRetrieve({\n  path: {\n    operationId: \"ops_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "developer_log_not_found",
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeveloperLogRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "log": {
                        "occurredAt": "2026-01-01T00:00:00.000Z",
                        "evidence": [],
                        "timeline": [],
                        "usage": [],
                        "operationId": "ops_sandbox_example0001",
                        "operation": "account.create",
                        "status": "accepted",
                        "audit": []
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, developer_log_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "developer_log_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders": {
      "post": {
        "operationId": "escrow_order_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create an escrow order",
        "description": "Opens escrow against an active listing and provisions its dedicated product escrow account. The amount, currency, and seller are derived from the locked listing -- never caller-supplied -- so escrow economics are the listing's by construction.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "escrow_order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "buyerAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "listingId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "escrow_order.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.created",
            "operation": "escrow_order.create",
            "operationId": "escrow_order_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_marketplace01\",\n    subject: \"sbj_sandbox_landcruiser1\",\n    buyerAccountId: \"acct_sandbox_buyer000001\",\n    listingId: \"lst_sandbox_landcruiser1\",\n    fundBy: \"2026-08-01T21:00:00.000Z\",\n    memo: \"Release after the vehicle is handed over.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EscrowOrderCreateInput"
              },
              "examples": {
                "open_vehicle_escrow": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "buyerAccountId": "acct_sandbox_buyer000001",
                    "listingId": "lst_sandbox_landcruiser1",
                    "fundBy": "2026-08-01T21:00:00.000Z",
                    "memo": "Release after the vehicle is handed over."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "buyerAccountId": "acct_sandbox_buyer000001",
                    "listingId": "lst_sandbox_landcruiser1",
                    "fundBy": "2026-08-01T21:00:00.000Z",
                    "memo": "Release after the vehicle is handed over."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "escrow_order_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List escrow orders",
        "description": "List escrow orders",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "escrow_order:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List escrow orders",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "funded",
                "disputed",
                "refund_quoted",
                "released",
                "refunded",
                "penalty_collected",
                "canceled",
                "expired"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "buyerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "sellerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "listingId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing whose subject and availability this escrow protects"
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "fundBy",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    buyerAccountId: \"acct_sandbox_example0001\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    listingId: \"lst_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    fundBy: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}": {
      "get": {
        "operationId": "escrow_order_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve an escrow order",
        "description": "Retrieve an escrow order",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "escrow_order:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an escrow order",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderRetrieve({\n  path: {\n    escrowOrderId: \"eord_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "escrow_order_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update an escrow order",
        "description": "Edits the mutable fields of an escrow order (fundBy, memo) while it is created. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "escrow_order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "escrow_order.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.updated",
            "operation": "escrow_order.update",
            "operationId": "escrow_order_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderUpdate({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n  body: {\n    fundBy: \"2026-08-01T21:00:00.000Z\",\n    memo: \"Buyer funds after inspection booking.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EscrowOrderUpdateBody"
              },
              "examples": {
                "annotate_unfunded_escrow": {
                  "value": {
                    "fundBy": "2026-08-01T21:00:00.000Z",
                    "memo": "Buyer funds after inspection booking."
                  }
                },
                "default": {
                  "value": {
                    "fundBy": "2026-08-01T21:00:00.000Z",
                    "memo": "Buyer funds after inspection booking."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/cancel": {
      "post": {
        "operationId": "escrow_order_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel an escrow order",
        "description": "Closes an unfunded escrow. Because no money moved, no unwind quote is required.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "escrow_order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "escrow_order.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.canceled",
            "operation": "escrow_order.cancel",
            "operationId": "escrow_order_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderCancel({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "canceled",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/collect-penalty": {
      "post": {
        "operationId": "escrow_order_collect_penalty",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect an escrow refund penalty",
        "description": "Pays the computed retained penalty to the seller after a penalized refund. Invoke only when refund returns a positive refs.unwindPenalty.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.collect_penalty",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "escrow_order:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.penalty_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "escrow_order.penalty_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect an escrow refund penalty",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.penalty_collected",
            "operation": "escrow_order.collect_penalty",
            "operationId": "escrow_order_collect_penalty",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderCollectPenaltyOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderCollectPenalty({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderCollectPenaltyOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "penalty_collected",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/dispute": {
      "post": {
        "operationId": "escrow_order_dispute",
        "tags": [
          "noun_instance"
        ],
        "summary": "Dispute an escrow order",
        "description": "Freezes the fully funded escrow before either milestone releases, preserving the entire balance while the parties decide what happens next.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.dispute",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "escrow_order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.disputed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "escrow_order.disputed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Dispute an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.disputed",
            "operation": "escrow_order.dispute",
            "operationId": "escrow_order_dispute",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderDisputeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderDispute({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderDisputeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "disputed",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/fund": {
      "post": {
        "operationId": "escrow_order_fund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund an escrow order",
        "description": "Moves the full purchase amount from the buyer account into the dedicated escrow account while the listing remains active.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.fund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "escrow_order:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "escrow_order.funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.funded",
            "operation": "escrow_order.fund",
            "operationId": "escrow_order_fund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderFundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderFund({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderFundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "funded",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/quote": {
      "post": {
        "operationId": "escrow_order_quote",
        "tags": [
          "noun_instance"
        ],
        "summary": "Quote an escrow refund",
        "description": "Calculates the full buyer refund while disputed and parks the escrow for explicit confirmation. No money moves at quote time.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.quote",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "escrow_order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.quoted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "escrow_order.quoted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Quote an escrow refund",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.quoted",
            "operation": "escrow_order.quote",
            "operationId": "escrow_order_quote",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderQuoteOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderQuote({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderQuoteOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "refund_quoted",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/refund": {
      "post": {
        "operationId": "escrow_order_refund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund an escrow order",
        "description": "Confirms the quoted retreat and returns the full held amount from escrow to the buyer.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.refund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "escrow_order:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "escrow_order.refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.refunded",
            "operation": "escrow_order.refund",
            "operationId": "escrow_order_refund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderRefundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderRefund({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderRefundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "refunded",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/release": {
      "post": {
        "operationId": "escrow_order_release",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release an escrow order",
        "description": "Pays the seller the full escrow amount once and closes escrow with no balance remaining. Only the escrow that reserved the listing can release: the listing must name this escrow back.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.release",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "escrow_order:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "commercial": {
            "earnable": true
          },
          "audit": {
            "event": "escrow_order.released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.released",
            "operation": "escrow_order.release",
            "operationId": "escrow_order_release",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderReleaseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderRelease({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderReleaseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "released",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/escrow-orders/{escrowOrderId}/resume": {
      "post": {
        "operationId": "escrow_order_resume",
        "tags": [
          "noun_instance"
        ],
        "summary": "Resume an escrow order",
        "description": "Ends the dispute hold without moving money and returns the fully funded escrow to its first milestone.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "escrow_order.resume",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "escrow_order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "escrow_order.resumed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "escrow_order.resumed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Resume an escrow order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Escrow Orders"
          ],
          "publicNoun": "Escrow order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "escrow_order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "escrow_order.resumed",
            "operation": "escrow_order.resume",
            "operationId": "escrow_order_resume",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/EscrowOrderResumeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "escrowOrderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.escrowOrderResume({\n  path: {\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscrowOrderResumeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "escrowOrderId": "eord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "escrow_order",
                      "status": "funded",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/events": {
      "get": {
        "operationId": "event_list",
        "tags": [
          "event"
        ],
        "summary": "List events",
        "description": "Lists versioned event envelopes for a tenant so webhook receivers can reconcile delivered events against Hyperscale audit truth. Ordered newest first. To consume exactly once: remember the newest event id already processed, follow the returned cursor until it reappears, and deduplicate by event id, never by position. Pass resourceId to narrow the stream to a single resource's timeline.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "event.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "event:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "event.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "audit",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List events",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Event",
          "viewId": "event",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "resourceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^[a-z][a-z0-9_]{2,160}$",
              "description": "Hyperscale resource ID an audit event was recorded against"
            }
          },
          {
            "name": "event",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$",
              "description": "Hyperscale audit event type emitted from an operation policy"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.eventList({\n  query: {\n    limit: 25,\n    cursor: \"cursor_sandbox_page0001\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    resourceId: \"resource_sandbox_example0001\",\n    event: \"account.create\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventListOutput"
                },
                "examples": {
                  "sandbox_events": {
                    "value": {
                      "items": [
                        {
                          "id": "aud_sandbox_event0001",
                          "object": "event",
                          "apiVersion": "2026-06-04",
                          "environment": "sandbox",
                          "tenantId": "ten_sandbox_riyadhresale01",
                          "event": "sale_settlement.piece_3_released",
                          "createdAt": "2026-07-22T12:00:00.000Z",
                          "operationId": "ops_sandbox_event0001",
                          "relatedObject": {
                            "id": "sale_sandbox_event0001",
                            "type": "noun_instance"
                          },
                          "data": {
                            "object": {
                              "operationName": "sale_settlement.release_piece_3",
                              "sourceSurface": "http",
                              "status": "released"
                            }
                          },
                          "outbox": {
                            "payloadDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000"
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/events/{eventId}": {
      "get": {
        "operationId": "event_retrieve",
        "tags": [
          "event"
        ],
        "summary": "Retrieve an event",
        "description": "Retrieves the canonical versioned internal audit event envelope by id for authenticated investigation and delivery recovery. It is not the redacted outbound webhook body and cannot be used to replay or verify webhook signatures.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "event.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "event:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "event.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "audit",
              "action": "read",
              "tenantScoped": true,
              "idPath": "eventId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an event",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Event",
          "viewId": "event",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "parameters": [
          {
            "name": "eventId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^aud_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale audit event ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.eventRetrieve({\n  path: {\n    eventId: \"aud_sandbox_event0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EventRetrieveOutput"
                },
                "examples": {
                  "sandbox_event": {
                    "value": {
                      "id": "aud_sandbox_event0001",
                      "object": "event",
                      "apiVersion": "2026-06-04",
                      "environment": "sandbox",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "event": "sale_settlement.piece_3_released",
                      "createdAt": "2026-07-22T12:00:00.000Z",
                      "operationId": "ops_sandbox_event0001",
                      "relatedObject": {
                        "id": "sale_sandbox_event0001",
                        "type": "noun_instance"
                      },
                      "data": {
                        "object": {
                          "operationName": "sale_settlement.release_piece_3",
                          "sourceSurface": "http",
                          "status": "released"
                        }
                      },
                      "outbox": {
                        "payloadDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/expected-payments": {
      "post": {
        "operationId": "expected_payment_create",
        "tags": [
          "expected_payment"
        ],
        "summary": "Create an expected payment",
        "description": "Create an expected payment",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "expected_payment.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "expected_payment.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "expected_payment",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            },
            {
              "kind": "financial_address",
              "action": "read",
              "tenantScoped": true,
              "idPath": "financialAddressId",
              "status": {
                "allowed": [
                  "active"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "expected_payment.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create an expected payment",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Expected payments"
          ],
          "publicNoun": "Expected payment",
          "resourceRef": "expected_payment",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "expected_payment.created",
            "operation": "expected_payment.create",
            "operationId": "expected_payment_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ExpectedPaymentCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.expectedPaymentCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_marketplace001\",\n    accountId: \"acct_sandbox_seller0001\",\n    financialAddressId: \"faddr_sandbox_customer0001\",\n    amountMin: \"24000\",\n    amountMax: \"26000\",\n    currency: \"SAR\",\n    windowStart: \"2026-07-09T00:00:00.000Z\",\n    windowEnd: \"2026-07-16T00:00:00.000Z\",\n    reference: \"vehicle-order-0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "financial_address_destination_mismatch",
          "financial_address_not_found",
          "financial_address_status_forbidden",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExpectedPaymentCreateInput"
              },
              "examples": {
                "expect_vehicle_payment": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace001",
                    "accountId": "acct_sandbox_seller0001",
                    "financialAddressId": "faddr_sandbox_customer0001",
                    "amountMin": "24000",
                    "amountMax": "26000",
                    "currency": "SAR",
                    "windowStart": "2026-07-09T00:00:00.000Z",
                    "windowEnd": "2026-07-16T00:00:00.000Z",
                    "reference": "vehicle-order-0001"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace001",
                    "accountId": "acct_sandbox_seller0001",
                    "financialAddressId": "faddr_sandbox_customer0001",
                    "amountMin": "24000",
                    "amountMax": "26000",
                    "currency": "SAR",
                    "windowStart": "2026-07-09T00:00:00.000Z",
                    "windowEnd": "2026-07-16T00:00:00.000Z",
                    "reference": "vehicle-order-0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExpectedPaymentCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "expectedPaymentId": "exp_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "accountId": "acct_sandbox_example0001",
                      "financialAddressId": "faddr_sandbox_example0001",
                      "amountMin": "1",
                      "amountMax": "1",
                      "amountReceived": "0",
                      "currency": "SAR",
                      "windowStart": "2026-01-01T00:00:00.000Z",
                      "windowEnd": "2026-02-01T00:00:00.000Z",
                      "status": "expected",
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "metadata": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, financial_address_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "financial_address_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, financial_address_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "financial_address_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, financial_address_destination_mismatch, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "financial_address_destination_mismatch",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "expected_payment_list",
        "tags": [
          "expected_payment"
        ],
        "summary": "List Expected payments",
        "description": "List Expected payments as a cursor-paginated page. A declaration that money should arrive: the account and address it is due on, the amount and date windows it must fall inside, and the reference to match. Incoming credits are matched against it to close a collection.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "expected_payment.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "expected_payment.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "expected_payment",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Expected payments",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Expected payments"
          ],
          "publicNoun": "Expected payment",
          "resourceRef": "expected_payment",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "expected",
                "partially_received",
                "received",
                "overdue",
                "canceled"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.expectedPaymentList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"expected\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExpectedPaymentListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/expected-payments/{expectedPaymentId}": {
      "get": {
        "operationId": "expected_payment_retrieve",
        "tags": [
          "expected_payment"
        ],
        "summary": "Retrieve an Expected payment",
        "description": "Retrieve a single Expected payment by its expectedPaymentId. A declaration that money should arrive: the account and address it is due on, the amount and date windows it must fall inside, and the reference to match. Incoming credits are matched against it to close a collection.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "expected_payment.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "expected_payment.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "expected_payment",
              "action": "read",
              "tenantScoped": true,
              "idPath": "expectedPaymentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an Expected payment",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Expected payments"
          ],
          "publicNoun": "Expected payment",
          "resourceRef": "expected_payment",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "parameters": [
          {
            "name": "expectedPaymentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.expectedPaymentRetrieve({\n  path: {\n    expectedPaymentId: \"pmt_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExpectedPaymentRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "expectedPaymentId": "exp_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/expected-payments/{expectedPaymentId}/cancel": {
      "post": {
        "operationId": "expected_payment_cancel",
        "tags": [
          "expected_payment"
        ],
        "summary": "Cancel an expected payment",
        "description": "Cancel an expected payment",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "expected_payment.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "expected_payment.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "expected_payment",
              "action": "write",
              "tenantScoped": true,
              "idPath": "expectedPaymentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "expected_payment.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel an expected payment",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Expected payments"
          ],
          "publicNoun": "Expected payment",
          "resourceRef": "expected_payment",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "deposits"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "expected_payment.canceled",
            "operation": "expected_payment.cancel",
            "operationId": "expected_payment_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ExpectedPaymentCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "expectedPaymentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^exp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale expected payment ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.expectedPaymentCancel({\n  path: {\n    expectedPaymentId: \"exp_sandbox_vehicle000001\",\n  },\n  body: {\n    reason: \"The order was canceled.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExpectedPaymentCancelBody"
              },
              "examples": {
                "cancel_expected_payment": {
                  "value": {
                    "reason": "The order was canceled."
                  }
                },
                "default": {
                  "value": {
                    "reason": "The order was canceled."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExpectedPaymentCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "expectedPaymentId": "exp_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "status": "canceled",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/exposure-arrangements": {
      "get": {
        "operationId": "exposure_arrangement_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List exposure arrangements",
        "description": "List exposure arrangements",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "exposure_arrangement.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "exposure_arrangement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "exposure_arrangement.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List exposure arrangements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Exposure Arrangements"
          ],
          "publicNoun": "Exposure arrangement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "exposure_arrangement"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending_approval",
                "approved",
                "rejected",
                "closed"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "borrowerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "approvedAmountsCapAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "approvedAmountsCapAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "outstandingCapAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "outstandingCapAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.exposureArrangementList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"pending_approval\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    approvedAmountsCapAmountFrom: \"1\",\n    approvedAmountsCapAmountTo: \"1\",\n    outstandingCapAmountFrom: \"1\",\n    outstandingCapAmountTo: \"1\",\n    currency: \"SAR\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExposureArrangementListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/exposure-arrangements/{exposureArrangementId}": {
      "get": {
        "operationId": "exposure_arrangement_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve an exposure arrangement",
        "description": "Retrieve an exposure arrangement",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "exposure_arrangement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "exposure_arrangement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "exposure_arrangement.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "exposureArrangementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an exposure arrangement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Exposure Arrangements"
          ],
          "publicNoun": "Exposure arrangement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "exposure_arrangement"
        ],
        "parameters": [
          {
            "name": "exposureArrangementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Exposure arrangement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.exposureArrangementRetrieve({\n  path: {\n    exposureArrangementId: \"earr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExposureArrangementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "exposureArrangementId": "earr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "exposure_arrangement",
                      "status": "pending_approval",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "borrowerEntityId": "ent_sandbox_example0001",
                        "currency": "SAR"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "exposure_arrangement_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update an exposure arrangement",
        "description": "Edits the mutable fields of an exposure arrangement (memo) while it is pending_approval or approved. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "exposure_arrangement.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "exposure_arrangement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "exposure_arrangement.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "exposureArrangementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "exposure_arrangement.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update an exposure arrangement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Exposure Arrangements"
          ],
          "publicNoun": "Exposure arrangement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "exposure_arrangement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "exposure_arrangement.updated",
            "operation": "exposure_arrangement.update",
            "operationId": "exposure_arrangement_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ExposureArrangementUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "exposureArrangementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Exposure arrangement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.exposureArrangementUpdate({\n  path: {\n    exposureArrangementId: \"earr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExposureArrangementUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExposureArrangementUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "exposureArrangementId": "earr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "exposure_arrangement",
                      "status": "pending_approval",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "borrowerEntityId": "ent_sandbox_example0001",
                        "currency": "SAR"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/exposure-arrangements/{exposureArrangementId}/approve": {
      "post": {
        "operationId": "exposure_arrangement_approve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Approve an exposure arrangement",
        "description": "Ratifies the limit as the lender's own credit decision. From here agreements may link the arrangement and draw under its caps.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "exposure_arrangement.approve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "exposure_arrangement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "exposure_arrangement.approved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "exposureArrangementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "exposure_arrangement.approved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Approve an exposure arrangement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Exposure Arrangements"
          ],
          "publicNoun": "Exposure arrangement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "exposure_arrangement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "exposure_arrangement.approved",
            "operation": "exposure_arrangement.approve",
            "operationId": "exposure_arrangement_approve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ExposureArrangementApproveOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "exposureArrangementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Exposure arrangement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.exposureArrangementApprove({\n  path: {\n    exposureArrangementId: \"earr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExposureArrangementApproveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "exposureArrangementId": "earr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "exposure_arrangement",
                      "status": "approved",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "borrowerEntityId": "ent_sandbox_example0001",
                        "currency": "SAR"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/exposure-arrangements/{exposureArrangementId}/close": {
      "post": {
        "operationId": "exposure_arrangement_close",
        "tags": [
          "noun_instance"
        ],
        "summary": "Close an exposure arrangement",
        "description": "Retires the limit once the borrower relationship ends. Already-linked agreements keep their history; new links and new advances against the arrangement refuse.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "exposure_arrangement.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "exposure_arrangement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "exposure_arrangement.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "exposureArrangementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "exposure_arrangement.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Close an exposure arrangement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Exposure Arrangements"
          ],
          "publicNoun": "Exposure arrangement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "exposure_arrangement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "exposure_arrangement.closed",
            "operation": "exposure_arrangement.close",
            "operationId": "exposure_arrangement_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ExposureArrangementCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "exposureArrangementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Exposure arrangement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.exposureArrangementClose({\n  path: {\n    exposureArrangementId: \"earr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExposureArrangementCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "exposureArrangementId": "earr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "exposure_arrangement",
                      "status": "closed",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "borrowerEntityId": "ent_sandbox_example0001",
                        "currency": "SAR"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/exposure-arrangements/{exposureArrangementId}/reject": {
      "post": {
        "operationId": "exposure_arrangement_reject",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reject an exposure arrangement",
        "description": "Refuses the proposed limit. The arrangement is terminal and no agreement can ever link it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "exposure_arrangement.reject",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "exposure_arrangement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "exposure_arrangement.rejected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "exposureArrangementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "exposure_arrangement.rejected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reject an exposure arrangement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Exposure Arrangements"
          ],
          "publicNoun": "Exposure arrangement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "exposure_arrangement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "exposure_arrangement.rejected",
            "operation": "exposure_arrangement.reject",
            "operationId": "exposure_arrangement_reject",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ExposureArrangementRejectOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "exposureArrangementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^earr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Exposure arrangement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.exposureArrangementReject({\n  path: {\n    exposureArrangementId: \"earr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExposureArrangementRejectOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "exposureArrangementId": "earr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "exposure_arrangement",
                      "status": "rejected",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "borrowerEntityId": "ent_sandbox_example0001",
                        "currency": "SAR"
                      },
                      "refs": {},
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/extensions": {
      "get": {
        "operationId": "extension_list",
        "tags": [
          "extension"
        ],
        "summary": "List catalog extensions",
        "description": "Lists every catalog extension a Product can be recomposed with: the business nouns it contributes and the nouns the Product must already contain for the extension to attach. Public and unauthenticated, like Blueprint discovery.",
        "security": [],
        "x-hyperscale-operation": "extension.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "extension.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "public",
          "tenant": {
            "mode": "none"
          },
          "resources": [],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List catalog extensions",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.extensionList({\n  query: {\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtensionListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/financial-addresses": {
      "post": {
        "operationId": "financial_address_create",
        "tags": [
          "financial_address"
        ],
        "summary": "Create a financial address",
        "description": "Requests an externally payable address for an account. Sandbox requests are ungated; live requests require confirmed tenant bank onboarding. The address becomes usable only after separate provider provisioning changes its status to active.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "financial_address.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "financial_address.requested",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "financial_address",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "accountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "financial_address.requested"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a financial address",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Financial addresses"
          ],
          "publicNoun": "Financial address",
          "resourceRef": "financial_address",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "financial_address.requested",
            "operation": "financial_address.create",
            "operationId": "financial_address_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FinancialAddressCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.financialAddressCreate({\n  body: {\n    accountId: \"acct_sandbox_customer0001\",\n    workspaceId: \"wsp_sandbox_marketplace001\",\n    purpose: \"Customer payments\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "account_role_not_financial_addressable",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "financial_address_account_status_forbidden",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "tenant_bank_confirmation_required"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FinancialAddressCreateInput"
              },
              "examples": {
                "request_customer_financial_address": {
                  "value": {
                    "accountId": "acct_sandbox_customer0001",
                    "workspaceId": "wsp_sandbox_marketplace001",
                    "purpose": "Customer payments"
                  }
                },
                "default": {
                  "value": {
                    "accountId": "acct_sandbox_customer0001",
                    "workspaceId": "wsp_sandbox_marketplace001",
                    "purpose": "Customer payments"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinancialAddressCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "financialAddressId": "faddr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "accountId": "acct_sandbox_example0001",
                      "status": "requested",
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "metadata": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, account_role_not_financial_addressable, financial_address_account_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "account_role_not_financial_addressable",
              "financial_address_account_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, customer_access_compliance_forbidden, operation_not_finalized, tenant_bank_confirmation_required.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "customer_access_compliance_forbidden",
              "operation_not_finalized",
              "tenant_bank_confirmation_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "financial_address_list",
        "tags": [
          "financial_address"
        ],
        "summary": "List Financial addresses",
        "description": "List Financial addresses as a cursor-paginated page. An externally payable address (IBAN) attached to a Hyperscale Account. It is how outside money reaches that account, and it holds no balance of its own.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "financial_address.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "financial_address.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "financial_address",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Financial addresses",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Financial address",
          "resourceRef": "financial_address",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "requested",
                "active",
                "disabled"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.financialAddressList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"requested\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinancialAddressListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/financial-addresses/{financialAddressId}": {
      "get": {
        "operationId": "financial_address_retrieve",
        "tags": [
          "financial_address"
        ],
        "summary": "Retrieve a Financial address",
        "description": "Retrieve a single Financial address by its financialAddressId. An externally payable address (IBAN) attached to a Hyperscale Account. It is how outside money reaches that account, and it holds no balance of its own.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "financial_address.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "financial_address.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "financial_address",
              "action": "read",
              "tenantScoped": true,
              "idPath": "financialAddressId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Financial address",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Accounts"
          ],
          "publicNoun": "Financial address",
          "resourceRef": "financial_address",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "financialAddressId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.financialAddressRetrieve({\n  path: {\n    financialAddressId: \"addr_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinancialAddressRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "financialAddressId": "faddr_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "address": "addr_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/financial-addresses/{financialAddressId}/disable": {
      "post": {
        "operationId": "financial_address_disable",
        "tags": [
          "financial_address"
        ],
        "summary": "Disable a financial address",
        "description": "Disable a financial address",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "financial_address.disable",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "financial_address.disabled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "financial_address",
              "action": "write",
              "tenantScoped": true,
              "idPath": "financialAddressId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "financial_address.disabled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Disable a financial address",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Financial addresses"
          ],
          "publicNoun": "Financial address",
          "resourceRef": "financial_address",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "financial_address.disabled",
            "operation": "financial_address.disable",
            "operationId": "financial_address_disable",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FinancialAddressDisableOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "financialAddressId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^faddr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale financial address ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.financialAddressDisable({\n  path: {\n    financialAddressId: \"faddr_sandbox_customer0001\",\n  },\n  body: {\n    reason: \"This address is no longer used.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "financial_address_lifecycle_status_forbidden",
          "financial_address_not_found",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FinancialAddressDisableBody"
              },
              "examples": {
                "disable_financial_address": {
                  "value": {
                    "reason": "This address is no longer used."
                  }
                },
                "default": {
                  "value": {
                    "reason": "This address is no longer used."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinancialAddressDisableOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "financialAddressId": "faddr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "accountId": "acct_sandbox_example0001",
                      "status": "disabled",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, financial_address_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "financial_address_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, financial_address_lifecycle_status_forbidden, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "financial_address_lifecycle_status_forbidden",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings": {
      "post": {
        "operationId": "flight_booking_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Hold a flight booking",
        "description": "Opens the booking as a hold against a flight itinerary subject at the quoted fare and provisions the dedicated fare reserve. No money moves until the booking confirms; the hold carries its own expiry deadline. A booking holding a leg of a packaged trip names its travel package, admitted only while that package is still draft or booked.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "travelerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "operatorAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "travelPackageId",
              "optional": true
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "flight_booking.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Hold a flight booking",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.created",
            "operation": "flight_booking.create",
            "operationId": "flight_booking_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    travelerAccountId: \"acct_sandbox_example0001\",\n    operatorAccountId: \"acct_sandbox_example0001\",\n    fareAmount: \"1\",\n    currency: \"SAR\",\n    holdExpiresAt: \"2026-01-01T00:00:00.000Z\",\n    departsAt: \"2026-01-01T00:00:00.000Z\",\n    subject: \"sbj_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FlightBookingCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "travelerAccountId": "acct_sandbox_example0001",
                    "operatorAccountId": "acct_sandbox_example0001",
                    "fareAmount": "1",
                    "currency": "SAR",
                    "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                    "departsAt": "2026-01-01T00:00:00.000Z",
                    "subject": "sbj_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "held",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "flight_booking_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List flight bookings",
        "description": "List flight bookings",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "flight_booking:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List flight bookings",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "held",
                "released",
                "confirmed",
                "cancel_quoted",
                "completed",
                "canceled",
                "penalty_collected",
                "package_canceled",
                "expired"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "travelerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "operatorAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "fareAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "fareAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "holdExpiresAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "departsAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "travelPackageId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Travel package this booking is a leg of"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"held\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    travelerAccountId: \"acct_sandbox_example0001\",\n    operatorAccountId: \"acct_sandbox_example0001\",\n    fareAmountFrom: \"1\",\n    fareAmountTo: \"1\",\n    currency: \"SAR\",\n    holdExpiresAt: \"2026-01-01T00:00:00.000Z\",\n    departsAt: \"2026-01-01T00:00:00.000Z\",\n    travelPackageId: \"tpkg_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}": {
      "get": {
        "operationId": "flight_booking_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a flight booking",
        "description": "Retrieve a flight booking",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "flight_booking:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a flight booking",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingRetrieve({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "held",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "flight_booking_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a flight booking",
        "description": "Edits the mutable fields of a flight booking (departsAt, bookingNote) while it is held or confirmed. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "flight_booking:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "flight_booking.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a flight booking",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.updated",
            "operation": "flight_booking.update",
            "operationId": "flight_booking_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingUpdate({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FlightBookingUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "held",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/amend-collect": {
      "post": {
        "operationId": "flight_booking_amend_collect",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect an amended fare increase",
        "description": "Reprices a confirmed booking whose amended itinerary costs more: the traveler pays the fare difference to the operator directly and the booking stays confirmed. The fare reserve is untouched; it still pays out in full at departure. Pair with flight_booking.update for the itinerary fields and amend_fee for the reissue fee.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.amend_collect",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.amendment_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "flight_booking.amendment_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect an amended fare increase",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.amendment_collected",
            "operation": "flight_booking.amend_collect",
            "operationId": "flight_booking_amend_collect",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingAmendCollectOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingAmendCollect({\n  path: {\n    flightBookingId: \"fbkg_sandbox_amend0000001\",\n  },\n  body: {\n    fareDifference: \"24000\",\n    amendmentNote: \"Rebooked SV1024 to the evening departure\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FlightBookingAmendCollectBody"
              },
              "examples": {
                "collect_reissued_fare_increase": {
                  "value": {
                    "fareDifference": "24000",
                    "amendmentNote": "Rebooked SV1024 to the evening departure"
                  }
                },
                "default": {
                  "value": {
                    "fareDifference": "24000",
                    "amendmentNote": "Rebooked SV1024 to the evening departure"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingAmendCollectOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "confirmed",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/amend-fee": {
      "post": {
        "operationId": "flight_booking_amend_fee",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect a flight amendment fee",
        "description": "Collects the operator's reissue fee for one amendment from the traveler, in either repricing direction. Declared as its own verb so a fee-free amendment simply never invokes it and an equal-fare reissue is a fee with no difference leg.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.amend_fee",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.amendment_fee_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "flight_booking.amendment_fee_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect a flight amendment fee",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.amendment_fee_collected",
            "operation": "flight_booking.amend_fee",
            "operationId": "flight_booking_amend_fee",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingAmendFeeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingAmendFee({\n  path: {\n    flightBookingId: \"fbkg_sandbox_amend0000001\",\n  },\n  body: {\n    amendmentFee: \"5000\",\n    amendmentNote: \"Carrier reissue fee for the date change\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FlightBookingAmendFeeBody"
              },
              "examples": {
                "collect_reissue_fee": {
                  "value": {
                    "amendmentFee": "5000",
                    "amendmentNote": "Carrier reissue fee for the date change"
                  }
                },
                "default": {
                  "value": {
                    "amendmentFee": "5000",
                    "amendmentNote": "Carrier reissue fee for the date change"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingAmendFeeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "confirmed",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/amend-refund": {
      "post": {
        "operationId": "flight_booking_amend_refund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund an amended fare decrease",
        "description": "Reprices a confirmed booking whose amended itinerary costs less: the operator refunds the fare difference to the traveler directly and the booking stays confirmed. The fare reserve is untouched, so the operator's departure payout still nets to the amended fare. Any reissue fee is collected separately by amend_fee.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.amend_refund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.amendment_refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "flight_booking.amendment_refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund an amended fare decrease",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.amendment_refunded",
            "operation": "flight_booking.amend_refund",
            "operationId": "flight_booking_amend_refund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingAmendRefundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingAmendRefund({\n  path: {\n    flightBookingId: \"fbkg_sandbox_amend0000001\",\n  },\n  body: {\n    fareDifference: \"18500\",\n    amendmentNote: \"Moved to the lower morning fare\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FlightBookingAmendRefundBody"
              },
              "examples": {
                "refund_reissued_fare_decrease": {
                  "value": {
                    "fareDifference": "18500",
                    "amendmentNote": "Moved to the lower morning fare"
                  }
                },
                "default": {
                  "value": {
                    "fareDifference": "18500",
                    "amendmentNote": "Moved to the lower morning fare"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingAmendRefundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "confirmed",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/cancel-confirm": {
      "post": {
        "operationId": "flight_booking_cancel_confirm",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm a flight booking cancellation",
        "description": "Unwinds the booking, refunding the fare minus the scheduled penalty from the fare reserve back to the traveler. The refund is repriced at confirm time into refs.unwindRefund; collect_penalty pays the retained remainder separately.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.cancel_confirm",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.cancel_confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "flight_booking.cancel_confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm a flight booking cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.cancel_confirmed",
            "operation": "flight_booking.cancel_confirm",
            "operationId": "flight_booking_cancel_confirm",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingCancelConfirmOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingCancelConfirm({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingCancelConfirmOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "canceled",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/cancel-quote": {
      "post": {
        "operationId": "flight_booking_cancel_quote",
        "tags": [
          "noun_instance"
        ],
        "summary": "Quote a flight booking cancellation",
        "description": "Parks the confirmed booking for cancellation and quotes the refund under the void-window penalty schedule. No money moves and the quote is advisory: the cancellation confirm reprices at its own clock.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.cancel_quote",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "flight_booking:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.cancel_quoted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "flight_booking.cancel_quoted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Quote a flight booking cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.cancel_quoted",
            "operation": "flight_booking.cancel_quote",
            "operationId": "flight_booking_cancel_quote",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingCancelQuoteOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingCancelQuote({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingCancelQuoteOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "cancel_quoted",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/collect-penalty": {
      "post": {
        "operationId": "flight_booking_collect_penalty",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect a flight cancellation penalty",
        "description": "Pays the computed retained cancellation penalty to the operator. Invoke only when cancel_confirm returns a positive refs.unwindPenalty.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.collect_penalty",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.penalty_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "flight_booking.penalty_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect a flight cancellation penalty",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.penalty_collected",
            "operation": "flight_booking.collect_penalty",
            "operationId": "flight_booking_collect_penalty",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingCollectPenaltyOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingCollectPenalty({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingCollectPenaltyOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "penalty_collected",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/confirm": {
      "post": {
        "operationId": "flight_booking_confirm",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm a flight booking",
        "description": "Runs a just-in-time air carrier decision under a deadline, then settles the fare from the traveler into the dedicated fare reserve and puts the booking in force. Refused once the hold expiry has passed, even if the expiry sweep has not fired yet.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.confirm",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "flight_booking:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "flight_booking.confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm a flight booking",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.confirmed",
            "operation": "flight_booking.confirm",
            "operationId": "flight_booking_confirm",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingConfirmOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingConfirm({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingConfirmOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "confirmed",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/flight-bookings/{flightBookingId}/release": {
      "post": {
        "operationId": "flight_booking_release",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release a held flight booking",
        "description": "Closes a hold the traveler abandoned before confirmation. No money has moved, so this is a pure lifecycle transition.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "flight_booking.release",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "flight_booking:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "flight_booking.released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "flightBookingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "flight_booking.released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release a held flight booking",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Flight Bookings"
          ],
          "publicNoun": "Flight booking",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "flight_booking"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "flight_booking.released",
            "operation": "flight_booking.release",
            "operationId": "flight_booking_release",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FlightBookingReleaseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "flightBookingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fbkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Flight booking instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.flightBookingRelease({\n  path: {\n    flightBookingId: \"fbkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FlightBookingReleaseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "flightBookingId": "fbkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "flight_booking",
                      "status": "released",
                      "fields": {
                        "travelerAccountId": "acct_sandbox_example0001",
                        "operatorAccountId": "acct_sandbox_example0001",
                        "fareAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "departsAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "fareReserveAccountId": "acct_sandbox_example0001",
                        "fareTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "farePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/funding-commitments": {
      "post": {
        "operationId": "funding_commitment_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Pledge into a funding round",
        "description": "Escrows the pledged amount from the investor account into the round's escrow account while the round is open. The currency, borrower, and escrow account are copied from the locked round, and the parent aggregate cap refuses any pledge past the remaining target headroom.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_commitment.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "funding_commitment:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_commitment.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingRoundId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "investorAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "funding_commitment.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Pledge into a funding round",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Commitments"
          ],
          "publicNoun": "Funding commitment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_commitment"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "funding_commitment.created",
            "operation": "funding_commitment.create",
            "operationId": "funding_commitment_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FundingCommitmentCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingCommitmentCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_p2pfinance1\",\n    fundingRoundId: \"fnr_sandbox_equipround1\",\n    investorAccountId: \"acct_sandbox_investor01\",\n    amount: \"250000\",\n    committedAt: \"2026-07-20T09:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FundingCommitmentCreateInput"
              },
              "examples": {
                "pledge_into_round": {
                  "value": {
                    "workspaceId": "wsp_sandbox_p2pfinance1",
                    "fundingRoundId": "fnr_sandbox_equipround1",
                    "investorAccountId": "acct_sandbox_investor01",
                    "amount": "250000",
                    "committedAt": "2026-07-20T09:00:00.000Z"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_p2pfinance1",
                    "fundingRoundId": "fnr_sandbox_equipround1",
                    "investorAccountId": "acct_sandbox_investor01",
                    "amount": "250000",
                    "committedAt": "2026-07-20T09:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingCommitmentCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "fundingCommitmentId": "fnc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "funding_commitment",
                      "status": "committed",
                      "fields": {
                        "fundingRoundId": "fnr_sandbox_example0001",
                        "investorAccountId": "acct_sandbox_example0001",
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "escrowAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "amount": "1",
                        "committedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "pledgeTransferId": "resource_sandbox_example0001",
                        "collectTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "funding_commitment_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List funding commitments",
        "description": "List funding commitments",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_commitment.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "funding_commitment:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_commitment.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List funding commitments",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Commitments"
          ],
          "publicNoun": "Funding commitment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_commitment"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "committed",
                "collected",
                "refunded"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "fundingRoundId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Funding round this pledge counts toward"
            }
          },
          {
            "name": "investorAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "borrowerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "escrowAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "committedAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingCommitmentList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"committed\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    fundingRoundId: \"fnr_sandbox_example0001\",\n    investorAccountId: \"acct_sandbox_example0001\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    escrowAccountId: \"acct_sandbox_example0001\",\n    currency: \"SAR\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    committedAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingCommitmentListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/funding-commitments/{fundingCommitmentId}": {
      "get": {
        "operationId": "funding_commitment_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a funding commitment",
        "description": "Retrieve a funding commitment",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_commitment.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "funding_commitment:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_commitment.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingCommitmentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a funding commitment",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Commitments"
          ],
          "publicNoun": "Funding commitment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_commitment"
        ],
        "parameters": [
          {
            "name": "fundingCommitmentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Funding commitment instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingCommitmentRetrieve({\n  path: {\n    fundingCommitmentId: \"fnc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingCommitmentRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "fundingCommitmentId": "fnc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "funding_commitment",
                      "status": "committed",
                      "fields": {
                        "fundingRoundId": "fnr_sandbox_example0001",
                        "investorAccountId": "acct_sandbox_example0001",
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "escrowAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "amount": "1",
                        "committedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "pledgeTransferId": "resource_sandbox_example0001",
                        "collectTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/funding-rounds": {
      "post": {
        "operationId": "funding_round_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Open a funding round",
        "description": "Declares the borrower, the all-or-nothing target, and the close moment, and provisions the round's escrow account pledges are held in. No money moves at open.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_round.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "funding_round:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_round.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "borrowerAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "funding_round.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Open a funding round",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Rounds"
          ],
          "publicNoun": "Funding round",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_round"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "funding_round.created",
            "operation": "funding_round.create",
            "operationId": "funding_round_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FundingRoundCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingRoundCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_p2pfinance1\",\n    borrowerAccountId: \"acct_sandbox_borrower001\",\n    targetAmount: \"500000\",\n    currency: \"SAR\",\n    closeBy: \"2026-08-15T21:00:00.000Z\",\n    memo: \"Bakery oven line expansion.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FundingRoundCreateInput"
              },
              "examples": {
                "open_equipment_round": {
                  "value": {
                    "workspaceId": "wsp_sandbox_p2pfinance1",
                    "borrowerAccountId": "acct_sandbox_borrower001",
                    "targetAmount": "500000",
                    "currency": "SAR",
                    "closeBy": "2026-08-15T21:00:00.000Z",
                    "memo": "Bakery oven line expansion."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_p2pfinance1",
                    "borrowerAccountId": "acct_sandbox_borrower001",
                    "targetAmount": "500000",
                    "currency": "SAR",
                    "closeBy": "2026-08-15T21:00:00.000Z",
                    "memo": "Bakery oven line expansion."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingRoundCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "fundingRoundId": "fnr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "funding_round",
                      "status": "open",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "targetAmount": "1",
                        "currency": "SAR",
                        "closeBy": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "funding_round_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List funding rounds",
        "description": "List funding rounds",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_round.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "funding_round:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_round.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List funding rounds",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Rounds"
          ],
          "publicNoun": "Funding round",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_round"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "open",
                "active",
                "failed",
                "settled"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "borrowerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "targetAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "targetAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "closeBy",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingRoundList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"open\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    targetAmountFrom: \"1\",\n    targetAmountTo: \"1\",\n    currency: \"SAR\",\n    closeBy: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingRoundListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/funding-rounds/{fundingRoundId}": {
      "get": {
        "operationId": "funding_round_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a funding round",
        "description": "Retrieve a funding round",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_round.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "funding_round:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_round.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingRoundId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a funding round",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Rounds"
          ],
          "publicNoun": "Funding round",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_round"
        ],
        "parameters": [
          {
            "name": "fundingRoundId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Funding round instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingRoundRetrieve({\n  path: {\n    fundingRoundId: \"fnr_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingRoundRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "fundingRoundId": "fnr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "funding_round",
                      "status": "open",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "targetAmount": "1",
                        "currency": "SAR",
                        "closeBy": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/funding-rounds/{fundingRoundId}/close": {
      "post": {
        "operationId": "funding_round_close",
        "tags": [
          "noun_instance"
        ],
        "summary": "Settle a collected round",
        "description": "Closes the round once every pledge has been collected into the borrower account; refused while any commitment is still outstanding.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "funding_round.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "funding_round:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "funding_round.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "fundingRoundId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "funding_round.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Settle a collected round",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Funding Rounds"
          ],
          "publicNoun": "Funding round",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "funding_round"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "funding_round.closed",
            "operation": "funding_round.close",
            "operationId": "funding_round_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/FundingRoundCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "fundingRoundId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Funding round instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.fundingRoundClose({\n  path: {\n    fundingRoundId: \"fnr_sandbox_equipround1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "aggregate_condition_unmet",
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FundingRoundCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "fundingRoundId": "fnr_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "funding_round",
                      "status": "settled",
                      "fields": {
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "targetAmount": "1",
                        "currency": "SAR",
                        "closeBy": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, aggregate_condition_unmet, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "aggregate_condition_unmet",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/held-settlements": {
      "post": {
        "operationId": "held_settlement_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Open a held settlement",
        "description": "Opens the hold and provisions its dedicated escrow account. The release date is fixed here and never moves.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "held_settlement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "payerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "payeeAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "platformAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "upstreamHeldSettlementId",
              "optional": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "held_settlement.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Open a held settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "held_settlement.created",
            "operation": "held_settlement.create",
            "operationId": "held_settlement_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HeldSettlementCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    payerAccountId: \"acct_sandbox_example0001\",\n    payeeAccountId: \"acct_sandbox_example0001\",\n    platformAccountId: \"acct_sandbox_example0001\",\n    heldAmount: \"1\",\n    serviceFeeAmount: \"1\",\n    currency: \"SAR\",\n    releaseDueAt: \"2026-01-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HeldSettlementCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "payerAccountId": "acct_sandbox_example0001",
                    "payeeAccountId": "acct_sandbox_example0001",
                    "platformAccountId": "acct_sandbox_example0001",
                    "heldAmount": "1",
                    "serviceFeeAmount": "1",
                    "currency": "SAR",
                    "releaseDueAt": "2026-01-01T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "heldSettlementId": "held_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "held_settlement",
                      "status": "created",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "payeeAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "heldAmount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR",
                        "releaseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundingTransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "deadlineReleaseTransferId": "resource_sandbox_example0001",
                        "cancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "held_settlement_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List held settlements",
        "description": "List held settlements",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "held_settlement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List held settlements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "funded",
                "released",
                "cancelled",
                "abandoned"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "payerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Party whose money is held until the hold resolves",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "payeeAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Party the hold protects and pays on release",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "platformAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Workspace revenue or customer balance account collecting the custody fee",
              "x-hyperscale-fee-collection-port": true,
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance",
                  "workspace_revenue"
                ]
              }
            }
          },
          {
            "name": "heldAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "heldAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "serviceFeeAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "serviceFeeAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "releaseDueAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
              "description": "Date the hold releases to the payee on its own; fixed at creation and the cutoff for both the release port and cancellation"
            }
          },
          {
            "name": "upstreamHeldSettlementId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hold this one is carved out of, when a chain of holds passes the same money down"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    payerAccountId: \"acct_sandbox_example0001\",\n    payeeAccountId: \"acct_sandbox_example0001\",\n    platformAccountId: \"acct_sandbox_example0001\",\n    heldAmountFrom: \"1\",\n    heldAmountTo: \"1\",\n    serviceFeeAmountFrom: \"1\",\n    serviceFeeAmountTo: \"1\",\n    releaseDueAt: \"2026-01-01T00:00:00.000Z\",\n    upstreamHeldSettlementId: \"held_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/held-settlements/{heldSettlementId}": {
      "get": {
        "operationId": "held_settlement_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a held settlement",
        "description": "Retrieve a held settlement",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "held_settlement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "heldSettlementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a held settlement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "parameters": [
          {
            "name": "heldSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Held settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementRetrieve({\n  path: {\n    heldSettlementId: \"held_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "heldSettlementId": "held_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "held_settlement",
                      "status": "created",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "payeeAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "heldAmount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR",
                        "releaseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundingTransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "deadlineReleaseTransferId": "resource_sandbox_example0001",
                        "cancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/held-settlements/{heldSettlementId}/abandon": {
      "post": {
        "operationId": "held_settlement_abandon",
        "tags": [
          "noun_instance"
        ],
        "summary": "Abandon the hold before it is funded",
        "description": "Closes a hold no money has entered, so an opened-then-dropped hold ends instead of staying open forever.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.abandon",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "held_settlement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.abandoned",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "heldSettlementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "held_settlement.abandoned"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Abandon the hold before it is funded",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "held_settlement.abandoned",
            "operation": "held_settlement.abandon",
            "operationId": "held_settlement_abandon",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HeldSettlementAbandonOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "heldSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Held settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementAbandon({\n  path: {\n    heldSettlementId: \"held_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementAbandonOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "heldSettlementId": "held_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "held_settlement",
                      "status": "abandoned",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "payeeAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "heldAmount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR",
                        "releaseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundingTransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "deadlineReleaseTransferId": "resource_sandbox_example0001",
                        "cancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/held-settlements/{heldSettlementId}/cancel": {
      "post": {
        "operationId": "held_settlement_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel the hold and return the held amount",
        "description": "Returns the whole held amount from escrow to the payer; the on-top custody fee stays posted because it paid for custody already provided. Shares the release date as its cutoff, so a cancellation can never land between the date and the sweep that releases on it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "held_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.cancelled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "heldSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "held_settlement.cancelled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel the hold and return the held amount",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "held_settlement.cancelled",
            "operation": "held_settlement.cancel",
            "operationId": "held_settlement_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HeldSettlementCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "heldSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Held settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementCancel({\n  path: {\n    heldSettlementId: \"held_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "heldSettlementId": "held_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "held_settlement",
                      "status": "cancelled",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "payeeAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "heldAmount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR",
                        "releaseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundingTransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "deadlineReleaseTransferId": "resource_sandbox_example0001",
                        "cancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/held-settlements/{heldSettlementId}/fund": {
      "post": {
        "operationId": "held_settlement_fund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund the hold and collect the custody fee",
        "description": "Moves the held amount from the payer into escrow and charges the custody fee on top, straight to the fee account, as one linked batch. The fee never enters escrow, so it is non-refundable by construction and the held amount stays whole for either exit.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.fund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "held_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "heldSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "held_settlement.funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund the hold and collect the custody fee",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "held_settlement.funded",
            "operation": "held_settlement.fund",
            "operationId": "held_settlement_fund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HeldSettlementFundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "heldSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Held settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementFund({\n  path: {\n    heldSettlementId: \"held_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementFundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "heldSettlementId": "held_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "held_settlement",
                      "status": "funded",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "payeeAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "heldAmount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR",
                        "releaseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundingTransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "deadlineReleaseTransferId": "resource_sandbox_example0001",
                        "cancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/held-settlements/{heldSettlementId}/release": {
      "post": {
        "operationId": "held_settlement_release",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release the hold to the payee early",
        "description": "The release port: the tenant's own backend rules that the condition is met and asserts the payer as the acting party, paying the payee out of escrow ahead of the release date. Refused once that date passes, where the machine release is the only remaining path.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "held_settlement.release",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "held_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "held_settlement.released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "heldSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "held_settlement.released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release the hold to the payee early",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Held Settlements"
          ],
          "publicNoun": "Held settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "held_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "held_settlement.released",
            "operation": "held_settlement.release",
            "operationId": "held_settlement_release",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HeldSettlementReleaseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "heldSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^held_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Held settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.heldSettlementRelease({\n  path: {\n    heldSettlementId: \"held_sandbox_example0001\",\n  },\n  body: {\n    actorAccountId: \"acct_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "port_actor_not_allowed",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HeldSettlementReleaseBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "actorAccountId": "acct_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HeldSettlementReleaseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "heldSettlementId": "held_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "held_settlement",
                      "status": "released",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "payeeAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "heldAmount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR",
                        "releaseDueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundingTransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "deadlineReleaseTransferId": "resource_sandbox_example0001",
                        "cancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, port_actor_not_allowed, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "port_actor_not_allowed",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays": {
      "post": {
        "operationId": "hotel_stay_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Hold a hotel stay",
        "description": "Opens the stay as a hold against a lodging stay subject at the quoted rate and provisions the dedicated rate reserve. No money moves until the stay confirms; the hold carries its own expiry deadline. A stay holding a leg of a packaged trip names its travel package, admitted only while that package is still draft or booked.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "guestAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "propertyAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "travelPackageId",
              "optional": true
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "hotel_stay.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Hold a hotel stay",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.created",
            "operation": "hotel_stay.create",
            "operationId": "hotel_stay_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    guestAccountId: \"acct_sandbox_example0001\",\n    propertyAccountId: \"acct_sandbox_example0001\",\n    rateAmount: \"1\",\n    currency: \"SAR\",\n    holdExpiresAt: \"2026-01-01T00:00:00.000Z\",\n    checkInAt: \"2026-01-01T00:00:00.000Z\",\n    checkOutAt: \"2026-01-01T00:00:00.000Z\",\n    subject: \"sbj_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HotelStayCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "guestAccountId": "acct_sandbox_example0001",
                    "propertyAccountId": "acct_sandbox_example0001",
                    "rateAmount": "1",
                    "currency": "SAR",
                    "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                    "checkInAt": "2026-01-01T00:00:00.000Z",
                    "checkOutAt": "2026-01-01T00:00:00.000Z",
                    "subject": "sbj_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "held",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "hotel_stay_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List hotel stays",
        "description": "List hotel stays",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "hotel_stay:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List hotel stays",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "held",
                "released",
                "confirmed",
                "cancel_quoted",
                "completed",
                "canceled",
                "penalty_collected",
                "package_canceled",
                "expired"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "guestAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "propertyAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "rateAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "rateAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "holdExpiresAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "checkInAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "checkOutAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "travelPackageId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Travel package this stay is a leg of"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"held\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    guestAccountId: \"acct_sandbox_example0001\",\n    propertyAccountId: \"acct_sandbox_example0001\",\n    rateAmountFrom: \"1\",\n    rateAmountTo: \"1\",\n    currency: \"SAR\",\n    holdExpiresAt: \"2026-01-01T00:00:00.000Z\",\n    checkInAt: \"2026-01-01T00:00:00.000Z\",\n    checkOutAt: \"2026-01-01T00:00:00.000Z\",\n    travelPackageId: \"tpkg_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}": {
      "get": {
        "operationId": "hotel_stay_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a hotel stay",
        "description": "Retrieve a hotel stay",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "hotel_stay:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a hotel stay",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayRetrieve({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "held",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "hotel_stay_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a hotel stay",
        "description": "Edits the mutable fields of a hotel stay (checkInAt, checkOutAt, stayNote) while it is held or confirmed. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "hotel_stay:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "hotel_stay.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a hotel stay",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.updated",
            "operation": "hotel_stay.update",
            "operationId": "hotel_stay_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayUpdate({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HotelStayUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "held",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/amend-collect": {
      "post": {
        "operationId": "hotel_stay_amend_collect",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect an amended rate increase",
        "description": "Reprices a confirmed stay whose amended dates or room cost more: the guest pays the rate difference to the property directly and the stay remains confirmed. The rate reserve is untouched; it still pays out in full at checkout. Pair with hotel_stay.update for the stay fields and amend_fee for the amendment fee.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.amend_collect",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.amendment_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "hotel_stay.amendment_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect an amended rate increase",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.amendment_collected",
            "operation": "hotel_stay.amend_collect",
            "operationId": "hotel_stay_amend_collect",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayAmendCollectOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayAmendCollect({\n  path: {\n    hotelStayId: \"hstay_sandbox_amend000001\",\n  },\n  body: {\n    rateDifference: \"32000\",\n    amendmentNote: \"Extended the stay by two nights\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HotelStayAmendCollectBody"
              },
              "examples": {
                "collect_extended_stay_increase": {
                  "value": {
                    "rateDifference": "32000",
                    "amendmentNote": "Extended the stay by two nights"
                  }
                },
                "default": {
                  "value": {
                    "rateDifference": "32000",
                    "amendmentNote": "Extended the stay by two nights"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayAmendCollectOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "confirmed",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/amend-fee": {
      "post": {
        "operationId": "hotel_stay_amend_fee",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect a stay amendment fee",
        "description": "Collects the property's amendment fee for one stay change from the guest, in either repricing direction. Declared as its own verb so a fee-free amendment simply never invokes it and an equal-rate change is a fee with no difference leg.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.amend_fee",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.amendment_fee_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "hotel_stay.amendment_fee_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect a stay amendment fee",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.amendment_fee_collected",
            "operation": "hotel_stay.amend_fee",
            "operationId": "hotel_stay_amend_fee",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayAmendFeeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayAmendFee({\n  path: {\n    hotelStayId: \"hstay_sandbox_amend000001\",\n  },\n  body: {\n    amendmentFee: \"7500\",\n    amendmentNote: \"Property fee for the date change\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HotelStayAmendFeeBody"
              },
              "examples": {
                "collect_date_change_fee": {
                  "value": {
                    "amendmentFee": "7500",
                    "amendmentNote": "Property fee for the date change"
                  }
                },
                "default": {
                  "value": {
                    "amendmentFee": "7500",
                    "amendmentNote": "Property fee for the date change"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayAmendFeeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "confirmed",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/amend-refund": {
      "post": {
        "operationId": "hotel_stay_amend_refund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund an amended rate decrease",
        "description": "Reprices a confirmed stay whose amended dates or room cost less: the property refunds the rate difference to the guest directly and the stay remains confirmed. The rate reserve is untouched, so the property's checkout payout still nets to the amended rate. Any amendment fee is collected separately by amend_fee.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.amend_refund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.amendment_refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "hotel_stay.amendment_refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund an amended rate decrease",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.amendment_refunded",
            "operation": "hotel_stay.amend_refund",
            "operationId": "hotel_stay_amend_refund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayAmendRefundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayAmendRefund({\n  path: {\n    hotelStayId: \"hstay_sandbox_amend000001\",\n  },\n  body: {\n    rateDifference: \"16000\",\n    amendmentNote: \"Shortened the stay by one night\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HotelStayAmendRefundBody"
              },
              "examples": {
                "refund_shortened_stay_decrease": {
                  "value": {
                    "rateDifference": "16000",
                    "amendmentNote": "Shortened the stay by one night"
                  }
                },
                "default": {
                  "value": {
                    "rateDifference": "16000",
                    "amendmentNote": "Shortened the stay by one night"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayAmendRefundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "confirmed",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/cancel-confirm": {
      "post": {
        "operationId": "hotel_stay_cancel_confirm",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm a hotel stay cancellation",
        "description": "Unwinds the stay, refunding the rate minus the scheduled penalty from the rate reserve back to the guest. The refund is repriced at confirm time into refs.unwindRefund; collect_penalty pays the retained remainder separately.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.cancel_confirm",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.cancel_confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "hotel_stay.cancel_confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm a hotel stay cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.cancel_confirmed",
            "operation": "hotel_stay.cancel_confirm",
            "operationId": "hotel_stay_cancel_confirm",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayCancelConfirmOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayCancelConfirm({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayCancelConfirmOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "canceled",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/cancel-quote": {
      "post": {
        "operationId": "hotel_stay_cancel_quote",
        "tags": [
          "noun_instance"
        ],
        "summary": "Quote a hotel stay cancellation",
        "description": "Parks the confirmed stay for cancellation and quotes the refund under the free-cancel penalty schedule. No money moves and the quote is advisory: the cancellation confirm reprices at its own clock.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.cancel_quote",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "hotel_stay:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.cancel_quoted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "hotel_stay.cancel_quoted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Quote a hotel stay cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.cancel_quoted",
            "operation": "hotel_stay.cancel_quote",
            "operationId": "hotel_stay_cancel_quote",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayCancelQuoteOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayCancelQuote({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayCancelQuoteOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "cancel_quoted",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/collect-penalty": {
      "post": {
        "operationId": "hotel_stay_collect_penalty",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect a hotel cancellation penalty",
        "description": "Pays the computed retained cancellation penalty to the property. Invoke only when cancel_confirm returns a positive refs.unwindPenalty.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.collect_penalty",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.penalty_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "hotel_stay.penalty_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect a hotel cancellation penalty",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.penalty_collected",
            "operation": "hotel_stay.collect_penalty",
            "operationId": "hotel_stay_collect_penalty",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayCollectPenaltyOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayCollectPenalty({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayCollectPenaltyOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "penalty_collected",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/confirm": {
      "post": {
        "operationId": "hotel_stay_confirm",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm a hotel stay",
        "description": "Runs a just-in-time lodging supplier decision under a deadline, then settles the rate from the guest into the dedicated rate reserve and commits the stay. Refused once the hold expiry has passed, even if the expiry sweep has not fired yet.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.confirm",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "hotel_stay:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "hotel_stay.confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm a hotel stay",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.confirmed",
            "operation": "hotel_stay.confirm",
            "operationId": "hotel_stay_confirm",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayConfirmOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayConfirm({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayConfirmOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "confirmed",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/hotel-stays/{hotelStayId}/release": {
      "post": {
        "operationId": "hotel_stay_release",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release a held hotel stay",
        "description": "Closes a hold the guest abandoned before confirmation. No money has moved, so this is a pure lifecycle transition.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "hotel_stay.release",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "hotel_stay:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "hotel_stay.released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "hotelStayId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "hotel_stay.released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release a held hotel stay",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Hotel Stays"
          ],
          "publicNoun": "Hotel stay",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "hotel_stay"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "hotel_stay.released",
            "operation": "hotel_stay.release",
            "operationId": "hotel_stay_release",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/HotelStayReleaseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "hotelStayId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^hstay_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hotel stay instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.hotelStayRelease({\n  path: {\n    hotelStayId: \"hstay_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HotelStayReleaseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "hotelStayId": "hstay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "hotel_stay",
                      "status": "released",
                      "fields": {
                        "guestAccountId": "acct_sandbox_example0001",
                        "propertyAccountId": "acct_sandbox_example0001",
                        "rateAmount": "1",
                        "currency": "SAR",
                        "holdExpiresAt": "2026-01-01T00:00:00.000Z",
                        "checkInAt": "2026-01-01T00:00:00.000Z",
                        "checkOutAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "rateReserveAccountId": "acct_sandbox_example0001",
                        "rateTransferId": "resource_sandbox_example0001",
                        "amendCollectTransferId": "resource_sandbox_example0001",
                        "amendRefundTransferId": "ref_sandbox_example0001",
                        "amendFeeTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "packageRefundTransferId": "ref_sandbox_example0001",
                        "ratePayoutTransferId": "pay_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/installments": {
      "post": {
        "operationId": "installment_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Schedule an installment",
        "description": "Opens one repayment slice against a credit agreement. The amount is admitted against the agreement's principal cap; no money moves until collection.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "installment.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "installment:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "installment.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "agreementId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "borrowerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "installment.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Schedule an installment",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Installments"
          ],
          "publicNoun": "Installment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "installment"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "installment.created",
            "operation": "installment.create",
            "operationId": "installment_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InstallmentCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.installmentCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    agreementId: \"cagr_sandbox_example0001\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    fundingAccountId: \"acct_sandbox_example0001\",\n    amount: \"1\",\n    currency: \"SAR\",\n    dueAt: \"2026-01-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InstallmentCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "agreementId": "cagr_sandbox_example0001",
                    "borrowerAccountId": "acct_sandbox_example0001",
                    "fundingAccountId": "acct_sandbox_example0001",
                    "amount": "1",
                    "currency": "SAR",
                    "dueAt": "2026-01-01T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallmentCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "installmentId": "inst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "installment",
                      "status": "scheduled",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "dueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "collectTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "installment_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List installments",
        "description": "List installments",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "installment.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "installment:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "installment.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List installments",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Installments"
          ],
          "publicNoun": "Installment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "installment"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "scheduled",
                "overdue",
                "collected",
                "written_off"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "agreementId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement this installment repays"
            }
          },
          {
            "name": "borrowerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "fundingAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "dueAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.installmentList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"scheduled\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    agreementId: \"cagr_sandbox_example0001\",\n    borrowerAccountId: \"acct_sandbox_example0001\",\n    fundingAccountId: \"acct_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    dueAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallmentListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/installments/{installmentId}": {
      "get": {
        "operationId": "installment_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve an installment",
        "description": "Retrieve an installment",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "installment.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "installment:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "installment.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "installmentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an installment",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Installments"
          ],
          "publicNoun": "Installment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "installment"
        ],
        "parameters": [
          {
            "name": "installmentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Installment instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.installmentRetrieve({\n  path: {\n    installmentId: \"inst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallmentRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "installmentId": "inst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "installment",
                      "status": "scheduled",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "dueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "collectTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "installment_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update an installment",
        "description": "Edits the mutable fields of an installment (memo) while it is scheduled. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "installment.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "installment:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "installment.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "installmentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "installment.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update an installment",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Installments"
          ],
          "publicNoun": "Installment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "installment"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "installment.updated",
            "operation": "installment.update",
            "operationId": "installment_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InstallmentUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "installmentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Installment instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.installmentUpdate({\n  path: {\n    installmentId: \"inst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InstallmentUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallmentUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "installmentId": "inst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "installment",
                      "status": "scheduled",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "dueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "collectTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/installments/{installmentId}/write-off": {
      "post": {
        "operationId": "installment_write_off",
        "tags": [
          "noun_instance"
        ],
        "summary": "Write off an installment",
        "description": "Closes an overdue slice that will never collect. The amount stays with the borrower; no clawback moves here, making this the honest loss path. Because a written-off slice counts as repaid at settlement, forgiveness is capped the same way collection is: collected and written-off siblings plus this slice must stay within what the agreement has actually disbursed.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "installment.write_off",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "installment:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "installment.written_off",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "installmentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "installment.written_off"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Write off an installment",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Installments"
          ],
          "publicNoun": "Installment",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "installment"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "installment.written_off",
            "operation": "installment.write_off",
            "operationId": "installment_write_off",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InstallmentWriteOffOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "installmentId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^inst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Installment instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.installmentWriteOff({\n  path: {\n    installmentId: \"inst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "aggregate_condition_unmet",
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallmentWriteOffOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "installmentId": "inst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "installment",
                      "status": "written_off",
                      "fields": {
                        "agreementId": "cagr_sandbox_example0001",
                        "borrowerAccountId": "acct_sandbox_example0001",
                        "fundingAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "dueAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "collectTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, aggregate_condition_unmet, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "aggregate_condition_unmet",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers": {
      "post": {
        "operationId": "internal_transfer_create",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Create an internal transfer",
        "description": "Posts a settled internal transfer in a single step, debiting the source account and crediting the destination account across the ledger. Both accounts must exist and share the transfer currency; a retry with the same Idempotency-Key returns the original transfer rather than moving the money twice. When the product charges an earn rate on this operation, the fee is taken out of the credited amount in the same atomic chain. The response then carries the total fee amount and currency, every provider, workspace, and platform ledger leg that distributed it, and `netAmount`, which is what the destination account kept.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sourceAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "destinationAccountId",
              "productBinding": "shared_tenant"
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "amountPath": "amount",
            "currencyPath": "currency",
            "deterministicTransferId": "operation",
            "lineage": "none",
            "sourceAccountIdPath": "sourceAccountId",
            "destinationAccountIdPath": "destinationAccountId",
            "transferSemantics": "post"
          },
          "metering": {
            "meter": "transfer.internal.count",
            "meters": [
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "commercial": {
            "earnable": true
          },
          "audit": {
            "event": "internal_transfer.created",
            "bodyKeys": [
              "metadata"
            ]
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create an internal transfer",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Internal Transfers"
          ],
          "publicNoun": "Internal Transfer",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "internal_transfer.created",
            "operation": "internal_transfer.create",
            "operationId": "internal_transfer_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InternalTransferCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferCreate({\n  body: {\n    sourceAccountId: \"acct_sandbox_buyer0001\",\n    destinationAccountId: \"acct_sandbox_seller0001\",\n    amount: \"25000\",\n    currency: \"SAR\",\n    memo: \"Order seller transfer\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InternalTransferCreateInput"
              },
              "examples": {
                "marketplace_seller_transfer": {
                  "value": {
                    "sourceAccountId": "acct_sandbox_buyer0001",
                    "destinationAccountId": "acct_sandbox_seller0001",
                    "amount": "25000",
                    "currency": "SAR",
                    "memo": "Order seller transfer"
                  }
                },
                "default": {
                  "value": {
                    "sourceAccountId": "acct_sandbox_buyer0001",
                    "destinationAccountId": "acct_sandbox_seller0001",
                    "amount": "25000",
                    "currency": "SAR",
                    "memo": "Order seller transfer"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "transferId": "trn_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "metadata": {},
                      "transferStatus": "posted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "internal_transfer_list",
        "tags": [
          "internal_transfer"
        ],
        "summary": "List Internal Transfers",
        "description": "List Internal Transfers as a cursor-paginated page. Money moving between two Hyperscale Accounts. It never crosses the provider boundary, and a reserved transfer holds the funds until it is posted or expires.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "internal_transfer:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Internal Transfers",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Internal Transfer",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "accepted",
                "reserved",
                "posted",
                "voided",
                "failed"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"accepted\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers/reserve": {
      "post": {
        "operationId": "internal_transfer_reserve",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Reserve an internal transfer",
        "description": "Opens a pending internal transfer that holds the amount on the source account without finalizing the movement; a later post settles it or a void releases it. An optional expiresAt sets a reservation deadline: at that instant the engine voids the remaining hold automatically and emits internal_transfer.expired (distinct from the internal_transfer.voided a deliberate void emits). expiresAt must be in the future and at most 4294967295 seconds (about 136 years) ahead; beyond that bound the reserve is refused with transfer_expiry_too_large. A retry with the same Idempotency-Key returns the original reservation rather than placing a second hold.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.reserve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.reserved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sourceAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "destinationAccountId",
              "productBinding": "shared_tenant"
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "amountPath": "amount",
            "currencyPath": "currency",
            "deterministicTransferId": "operation",
            "lineage": "none",
            "sourceAccountIdPath": "sourceAccountId",
            "destinationAccountIdPath": "destinationAccountId",
            "transferSemantics": "reserve"
          },
          "metering": {},
          "audit": {
            "event": "internal_transfer.reserved",
            "bodyKeys": [
              "metadata",
              "expiresAt"
            ]
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reserve an internal transfer",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Transfer reserve",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "internal_transfer.reserved",
            "operation": "internal_transfer.reserve",
            "operationId": "internal_transfer_reserve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InternalTransferReserveOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferReserve({\n  body: {\n    sourceAccountId: \"acct_sandbox_example0001\",\n    destinationAccountId: \"acct_sandbox_example0001\",\n    amount: \"1\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_expiry_invalid",
          "transfer_expiry_past",
          "transfer_expiry_too_large",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InternalTransferReserveInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "sourceAccountId": "acct_sandbox_example0001",
                    "destinationAccountId": "acct_sandbox_example0001",
                    "amount": "1",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferReserveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "transferId": "trn_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "metadata": {},
                      "transferStatus": "reserved"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_expiry_invalid, transfer_expiry_past, transfer_expiry_too_large, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_expiry_invalid",
              "transfer_expiry_past",
              "transfer_expiry_too_large",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers/{originalTransferId}/adjust": {
      "post": {
        "operationId": "internal_transfer_adjust",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Adjust a posted transfer",
        "description": "Creates a bounded adjustment transfer over the original account pair. The adjustment amount must be less than the posted transfer amount and the currency must match.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.adjust",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal",
          "system_internal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.adjusted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true,
              "idPath": "originalTransferId",
              "status": {
                "allowed": [
                  "posted"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "deterministicTransferId": "operation",
            "lineage": "correction_of",
            "pendingTransferIdPath": "originalTransferId",
            "transferSemantics": "correction",
            "amountPath": "amount",
            "currencyPath": "currency"
          },
          "metering": {},
          "audit": {
            "event": "internal_transfer.adjusted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Adjust a posted transfer",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Transfer adjustment",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "internal_transfer.adjusted",
            "operation": "internal_transfer.adjust",
            "operationId": "internal_transfer_adjust",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InternalTransferAdjustOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "originalTransferId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale transfer ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferAdjust({\n  path: {\n    originalTransferId: \"trn_sandbox_example0001\",\n  },\n  body: {\n    amount: \"1\",\n    currency: \"SAR\",\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_adjustment_amount_invalid",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InternalTransferAdjustBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "amount": "1",
                    "currency": "SAR",
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferAdjustOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "originalTransferId": "trn_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "transferStatus": "posted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_adjustment_amount_invalid, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_adjustment_amount_invalid",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers/{originalTransferId}/reverse": {
      "post": {
        "operationId": "internal_transfer_reverse",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Reverse a posted transfer in full",
        "description": "Creates a separate ledger-backed transfer that fully reverses a posted transfer by moving the original amount back over the original account pair.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.reverse",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal",
          "system_internal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.reversed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true,
              "idPath": "originalTransferId",
              "status": {
                "allowed": [
                  "posted"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "deterministicTransferId": "operation",
            "lineage": "correction_of",
            "pendingTransferIdPath": "originalTransferId",
            "transferSemantics": "correction"
          },
          "metering": {},
          "audit": {
            "event": "internal_transfer.reversed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reverse a posted transfer in full",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Transfer reversal",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "internal_transfer.reversed",
            "operation": "internal_transfer.reverse",
            "operationId": "internal_transfer_reverse",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InternalTransferReverseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "originalTransferId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale transfer ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferReverse({\n  path: {\n    originalTransferId: \"trn_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InternalTransferReverseBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferReverseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "originalTransferId": "trn_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "transferStatus": "posted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers/{transferId}": {
      "get": {
        "operationId": "internal_transfer_retrieve",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Retrieve an Internal Transfer",
        "description": "Retrieve a single Internal Transfer by its transferId. Money moving between two Hyperscale Accounts. It never crosses the provider boundary, and a reserved transfer holds the funds until it is posted or expires.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "internal_transfer:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "read",
              "tenantScoped": true,
              "idPath": "transferId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an Internal Transfer",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Internal Transfer",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferRetrieve({\n  path: {\n    transferId: \"resource_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "transferId": "trn_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers/{transferId}/post": {
      "post": {
        "operationId": "internal_transfer_post",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Post a reserved transfer",
        "description": "Finalizes a standalone reserved transfer, converting the pending hold into a settled debit and credit across the account pair. A transfer attached to another resource must be finalized through that resource's lifecycle. Omitting amount posts the full remaining hold and emits internal_transfer.posted. Supplying amount and currency posts exactly that amount while the remainder stays reserved: the reservation continues with the reduced amount, the record keeps the original reserved amount alongside the cumulative postedAmount, and the operation emits internal_transfer.partially_posted. postMode partial_only also refuses an amount equal to the remainder, which lets a lifecycle keep a reservation open for later slices. Releasing a remainder is only ever an explicit void or the reservation's own expiry, never a side effect of posting. The transfer must still be reserved; posting an already-posted transfer is rejected, and a retry with the same Idempotency-Key returns the settled result rather than moving the money twice.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.post",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.posted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true,
              "idPath": "transferId",
              "status": {
                "allowed": [
                  "reserved"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "deterministicTransferId": "resource_finalization",
            "lineage": "pending_transfer",
            "pendingTransferIdPath": "transferId",
            "transferSemantics": "post_pending"
          },
          "metering": {
            "meter": "transfer.internal.count",
            "meters": [
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "internal_transfer.posted",
            "eventByStatus": {
              "reserved": "internal_transfer.partially_posted"
            },
            "bodyKeys": [
              "postedAmount",
              "remainingReservedAmount"
            ]
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Post a reserved transfer",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Transfer post",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "internal_transfer.posted",
            "operation": "internal_transfer.post",
            "operationId": "internal_transfer_post",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InternalTransferPostOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale transfer ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferPost({\n  path: {\n    transferId: \"trn_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_post_amount_invalid",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InternalTransferPostBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferPostOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "transferStatus": "posted",
                      "amount": "1",
                      "currency": "SAR",
                      "postedAmount": "1",
                      "remainingReservedAmount": "40000"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_post_amount_invalid, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_post_amount_invalid",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/internal-transfers/{transferId}/void": {
      "post": {
        "operationId": "internal_transfer_void",
        "tags": [
          "internal_transfer"
        ],
        "summary": "Void a reserved transfer",
        "description": "Cancels a standalone reserved transfer and releases the remaining pending hold back to the source account. After a partial post only the unsettled remainder is released; the settled postedAmount stays posted. A transfer attached to another resource must be finalized through that resource's lifecycle. Only a reserved transfer can be voided; a posted transfer must be reversed instead.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "internal_transfer.void",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal",
          "system_internal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "internal_transfer.voided",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true,
              "idPath": "transferId",
              "status": {
                "allowed": [
                  "reserved"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "deterministicTransferId": "resource_finalization",
            "lineage": "pending_transfer",
            "pendingTransferIdPath": "transferId",
            "transferSemantics": "void_pending"
          },
          "metering": {},
          "audit": {
            "event": "internal_transfer.voided"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Void a reserved transfer",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Accounts",
            "Transfers"
          ],
          "publicNoun": "Transfer void",
          "resourceRef": "internal_transfer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "internal_transfer.voided",
            "operation": "internal_transfer.void",
            "operationId": "internal_transfer_void",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/InternalTransferVoidOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "transferId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trn_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale transfer ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.internalTransferVoid({\n  path: {\n    transferId: \"trn_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "destination_account_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InternalTransferVoidBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalTransferVoidOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "transferId": "trn_sandbox_example0001",
                      "transferStatus": "voided"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/invoice-lines": {
      "get": {
        "operationId": "invoice_line_list",
        "tags": [
          "invoice_line"
        ],
        "summary": "List Invoice lines",
        "description": "List Invoice lines as a cursor-paginated page. One priced line of an invoice: the meter it came from, the quantity billed, the unit amount, and the resulting subtotal.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "invoice_line.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "invoice_line.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "invoice_line",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Invoice lines",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Invoice line",
          "resourceRef": "invoice_line",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "invoiceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^inv_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale invoice ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.invoiceLineList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    invoiceId: \"inv_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceLineListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/invoice-lines/{invoiceLineId}": {
      "get": {
        "operationId": "invoice_line_retrieve",
        "tags": [
          "invoice_line"
        ],
        "summary": "Retrieve an Invoice line",
        "description": "Retrieve a single Invoice line by its invoiceLineId. One priced line of an invoice: the meter it came from, the quantity billed, the unit amount, and the resulting subtotal.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "invoice_line.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "invoice_line.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "invoice_line",
              "action": "read",
              "tenantScoped": true,
              "idPath": "invoiceLineId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an Invoice line",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Invoice line",
          "resourceRef": "invoice_line",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "invoiceLineId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.invoiceLineRetrieve({\n  path: {\n    invoiceLineId: \"invl_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceLineRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "invoiceLineId": "invl_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/invoices": {
      "get": {
        "operationId": "invoice_list",
        "tags": [
          "invoice"
        ],
        "summary": "List Invoices",
        "description": "List Invoices as a cursor-paginated page. The billed total for one billing period: the subtotal of its lines, the credit applied against it, and the amount owed. Finalizing an invoice freezes those numbers.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "invoice.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "invoice.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "invoice",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Invoices",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Invoice",
          "resourceRef": "invoice",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "billingPeriodId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale billing period ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "draft",
                "finalized",
                "charged",
                "paid",
                "voided",
                "credited"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.invoiceList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    billingPeriodId: \"bper_sandbox_example0001\",\n    status: \"draft\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/invoices/{invoiceId}": {
      "get": {
        "operationId": "invoice_retrieve",
        "tags": [
          "invoice"
        ],
        "summary": "Retrieve an Invoice",
        "description": "Retrieve a single Invoice by its invoiceId. The billed total for one billing period: the subtotal of its lines, the credit applied against it, and the amount owed. Finalizing an invoice freezes those numbers.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "invoice.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "billing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "invoice.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "invoice",
              "action": "read",
              "tenantScoped": true,
              "idPath": "invoiceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an Invoice",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Invoices"
          ],
          "publicNoun": "Invoice",
          "resourceRef": "invoice",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "invoiceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.invoiceRetrieve({\n  path: {\n    invoiceId: \"inv_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "invoiceId": "inv_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/kyc/requirements": {
      "get": {
        "operationId": "kyc_requirements_retrieve",
        "tags": [
          "kyc"
        ],
        "summary": "Retrieve KYC tier requirements",
        "description": "Projects the country's tier ladder from the Hyperscale contract configuration: each tier with its composed field groups and the full field catalog (types, enumerations, validation patterns, conditional requirements). App builders render onboarding forms directly from this projection, so the form and the engine's tier computation can never drift.",
        "security": [],
        "x-hyperscale-operation": "kyc.requirements.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "kyc.requirements.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "public",
          "tenant": {
            "mode": "none"
          },
          "resources": [],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve KYC tier requirements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "parameters": [
          {
            "name": "country",
            "in": "query",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 2,
              "maxLength": 2,
              "pattern": "^[A-Z]{2}$",
              "description": "ISO 3166-1 alpha-2 country code"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.kycRequirementsRetrieve({\n  query: {\n    country: \"SA\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "kyc_country_unsupported"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/KycRequirementsRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "country": "SA",
                      "tiers": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, kyc_country_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "kyc_country_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The credential is missing, invalid, or not authorized for this operation.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "unauthorized",
                        "message": "The request did not include a valid Hyperscale bearer credential for this environment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/lender-distributions": {
      "post": {
        "operationId": "lender_distribution_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Claim a lender's share of an agreement's repayments",
        "description": "Opens one distribution claim per funding commitment against a round-funded credit agreement, admitted only while the agreement is advanced -- the servicing window, disjoint from the paying window, so the claimant set is frozen before any share is computed. The lender and weight are copied from the collected pledge, the currency and pool account from the agreement, and the shared round is matched on both sides. A second claim on the same pledge is refused. No money moves at claim.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "lender_distribution.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "lender_distribution:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "lender_distribution.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "creditAgreementId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingRoundId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "fundingCommitmentId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "lender_distribution.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Claim a lender's share of an agreement's repayments",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Lender Distributions"
          ],
          "publicNoun": "Lender distribution",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "lender_distribution"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "lender_distribution.created",
            "operation": "lender_distribution.create",
            "operationId": "lender_distribution_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/LenderDistributionCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.lenderDistributionCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    creditAgreementId: \"cagr_sandbox_example0001\",\n    fundingRoundId: \"fnr_sandbox_example0001\",\n    fundingCommitmentId: \"fnc_sandbox_example0001\",\n    claimedAt: \"2026-01-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_already_claimed",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LenderDistributionCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "creditAgreementId": "cagr_sandbox_example0001",
                    "fundingRoundId": "fnr_sandbox_example0001",
                    "fundingCommitmentId": "fnc_sandbox_example0001",
                    "claimedAt": "2026-01-01T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LenderDistributionCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "lenderDistributionId": "lnd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "lender_distribution",
                      "status": "claimed",
                      "fields": {
                        "creditAgreementId": "cagr_sandbox_example0001",
                        "fundingRoundId": "fnr_sandbox_example0001",
                        "fundingCommitmentId": "fnc_sandbox_example0001",
                        "lenderAccountId": "acct_sandbox_example0001",
                        "poolAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "claimedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "payoutTransferId": "pay_sandbox_example0001",
                        "payoutShare": "pay_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_already_claimed, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_already_claimed",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "lender_distribution_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List lender distributions",
        "description": "List lender distributions",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "lender_distribution.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "lender_distribution:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "lender_distribution.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List lender distributions",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Lender Distributions"
          ],
          "publicNoun": "Lender distribution",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "lender_distribution"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "claimed",
                "paid"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "creditAgreementId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cagr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Credit agreement whose repaid pool this claim draws from"
            }
          },
          {
            "name": "fundingRoundId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnr_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Funding round shared by the agreement and the commitment"
            }
          },
          {
            "name": "fundingCommitmentId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^fnc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Collected pledge this distribution pays back"
            }
          },
          {
            "name": "lenderAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "poolAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "claimedAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.lenderDistributionList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"claimed\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    creditAgreementId: \"cagr_sandbox_example0001\",\n    fundingRoundId: \"fnr_sandbox_example0001\",\n    fundingCommitmentId: \"fnc_sandbox_example0001\",\n    lenderAccountId: \"acct_sandbox_example0001\",\n    poolAccountId: \"acct_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    claimedAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LenderDistributionListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/lender-distributions/{lenderDistributionId}": {
      "get": {
        "operationId": "lender_distribution_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a lender distribution",
        "description": "Retrieve a lender distribution",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "lender_distribution.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "lender_distribution:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "lender_distribution.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "lenderDistributionId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a lender distribution",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Lender Distributions"
          ],
          "publicNoun": "Lender distribution",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "lender_distribution"
        ],
        "parameters": [
          {
            "name": "lenderDistributionId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lnd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Lender distribution instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.lenderDistributionRetrieve({\n  path: {\n    lenderDistributionId: \"lnd_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LenderDistributionRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "lenderDistributionId": "lnd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "lender_distribution",
                      "status": "claimed",
                      "fields": {
                        "creditAgreementId": "cagr_sandbox_example0001",
                        "fundingRoundId": "fnr_sandbox_example0001",
                        "fundingCommitmentId": "fnc_sandbox_example0001",
                        "lenderAccountId": "acct_sandbox_example0001",
                        "poolAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR",
                        "claimedAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "payoutTransferId": "pay_sandbox_example0001",
                        "payoutShare": "pay_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings": {
      "post": {
        "operationId": "listing_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Draft a listing",
        "description": "Creates a private offer against one subject. Publishing is a separate, explicit decision.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sellerAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "escrowOrderId",
              "optional": true
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "listing.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Draft a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.created",
            "operation": "listing.create",
            "operationId": "listing_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_marketplace01\",\n    subject: \"sbj_sandbox_landcruiser1\",\n    sellerAccountId: \"acct_sandbox_seller0001\",\n    headline: \"2021 Toyota Land Cruiser GXR\",\n    description: \"Single owner, full service history, sold under escrow protection.\",\n    askingPrice: \"240000\",\n    currency: \"SAR\",\n    imageUrl: \"https://cdn.sandbox.example/listings/landcruiser-2021.jpg\",\n    expiresAt: \"2026-08-31T21:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingCreateInput"
              },
              "examples": {
                "draft_vehicle_offer": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "sellerAccountId": "acct_sandbox_seller0001",
                    "headline": "2021 Toyota Land Cruiser GXR",
                    "description": "Single owner, full service history, sold under escrow protection.",
                    "askingPrice": "240000",
                    "currency": "SAR",
                    "imageUrl": "https://cdn.sandbox.example/listings/landcruiser-2021.jpg",
                    "expiresAt": "2026-08-31T21:00:00.000Z"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "sellerAccountId": "acct_sandbox_seller0001",
                    "headline": "2021 Toyota Land Cruiser GXR",
                    "description": "Single owner, full service history, sold under escrow protection.",
                    "askingPrice": "240000",
                    "currency": "SAR",
                    "imageUrl": "https://cdn.sandbox.example/listings/landcruiser-2021.jpg",
                    "expiresAt": "2026-08-31T21:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "draft",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "listing_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List listings",
        "description": "List listings",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "listing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List listings",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "draft",
                "active",
                "reserved",
                "sold",
                "withdrawn"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "sellerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "askingPriceFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "askingPriceTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "escrowOrderId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order whose held funds reserve this listing"
            }
          },
          {
            "name": "expiresAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"draft\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    askingPriceFrom: \"1\",\n    askingPriceTo: \"1\",\n    currency: \"SAR\",\n    escrowOrderId: \"eord_sandbox_example0001\",\n    expiresAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings/{listingId}": {
      "get": {
        "operationId": "listing_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a listing",
        "description": "Retrieve a listing",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "listing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a listing",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingRetrieve({\n  path: {\n    listingId: \"lst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "draft",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "listing_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a listing",
        "description": "Edits the mutable fields of a listing (headline, description, askingPrice, imageUrl, escrowOrderId, expiresAt) while it is draft or active. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "listing.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.updated",
            "operation": "listing.update",
            "operationId": "listing_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingUpdate({\n  path: {\n    listingId: \"lst_sandbox_landcruiser1\",\n  },\n  body: {\n    askingPrice: \"240000\",\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListingUpdateBody"
              },
              "examples": {
                "attach_funded_escrow": {
                  "value": {
                    "askingPrice": "240000",
                    "escrowOrderId": "eord_sandbox_buyerorder01"
                  }
                },
                "default": {
                  "value": {
                    "askingPrice": "240000",
                    "escrowOrderId": "eord_sandbox_buyerorder01"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "draft",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings/{listingId}/publish": {
      "post": {
        "operationId": "listing_publish",
        "tags": [
          "noun_instance"
        ],
        "summary": "Publish a listing",
        "description": "Makes the draft visible and buyable.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.publish",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.published",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "listing.published"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Publish a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.published",
            "operation": "listing.publish",
            "operationId": "listing_publish",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingPublishOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingPublish({\n  path: {\n    listingId: \"lst_sandbox_landcruiser1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingPublishOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "active",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings/{listingId}/reopen": {
      "post": {
        "operationId": "listing_reopen",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reopen a listing",
        "description": "Returns the offer to the market after escrow closes without releasing money to the seller.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.reopen",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.reopened",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "listing.reopened"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reopen a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.reopened",
            "operation": "listing.reopen",
            "operationId": "listing_reopen",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingReopenOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingReopen({\n  path: {\n    listingId: \"lst_sandbox_landcruiser1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingReopenOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "active",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings/{listingId}/reserve": {
      "post": {
        "operationId": "listing_reserve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reserve a listing",
        "description": "Takes the offer off the market only while its referenced escrow order holds the buyer's funds for this exact listing at its exact economics.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.reserve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.reserved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "listing.reserved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reserve a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.reserved",
            "operation": "listing.reserve",
            "operationId": "listing_reserve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingReserveOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingReserve({\n  path: {\n    listingId: \"lst_sandbox_landcruiser1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingReserveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "reserved",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings/{listingId}/sell": {
      "post": {
        "operationId": "listing_sell",
        "tags": [
          "noun_instance"
        ],
        "summary": "Sell a listing",
        "description": "Marks the subject sold only after the escrow opened against this exact listing has released the full asking price to this seller.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.sell",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.sold",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "listing.sold"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Sell a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.sold",
            "operation": "listing.sell",
            "operationId": "listing_sell",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingSellOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingSell({\n  path: {\n    listingId: \"lst_sandbox_landcruiser1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingSellOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "sold",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/listings/{listingId}/withdraw": {
      "post": {
        "operationId": "listing_withdraw",
        "tags": [
          "noun_instance"
        ],
        "summary": "Withdraw a listing",
        "description": "Closes a draft or active offer before any escrow reservation exists.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "listing.withdraw",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "listing.withdrawn",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "listingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "listing.withdrawn"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Withdraw a listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Listings"
          ],
          "publicNoun": "Listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "listing.withdrawn",
            "operation": "listing.withdraw",
            "operationId": "listing_withdraw",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/ListingWithdrawOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "listingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.listingWithdraw({\n  path: {\n    listingId: \"lst_sandbox_landcruiser1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingWithdrawOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "listingId": "lst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "listing",
                      "status": "withdrawn",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/meter-period-snapshots": {
      "get": {
        "operationId": "meter_period_snapshot_list",
        "tags": [
          "meter_period_snapshot"
        ],
        "summary": "List Meter period snapshots",
        "description": "List Meter period snapshots as a cursor-paginated page. One meter's quantity frozen for one billing period. Invoicing prices the snapshot rather than the live counter, so later usage can never change a closed bill.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "meter_period_snapshot.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "meter_period_snapshot.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "meter_period_snapshot",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Meter period snapshots",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Usage"
          ],
          "publicNoun": "Meter period snapshot",
          "resourceRef": "meter_period_snapshot",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "billingPeriodId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^bper_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale billing period ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.meterPeriodSnapshotList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    billingPeriodId: \"bper_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeterPeriodSnapshotListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/meter-period-snapshots/{meterPeriodSnapshotId}": {
      "get": {
        "operationId": "meter_period_snapshot_retrieve",
        "tags": [
          "meter_period_snapshot"
        ],
        "summary": "Retrieve a Meter period snapshot",
        "description": "Retrieve a single Meter period snapshot by its meterPeriodSnapshotId. One meter's quantity frozen for one billing period. Invoicing prices the snapshot rather than the live counter, so later usage can never change a closed bill.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "meter_period_snapshot.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "meter_period_snapshot.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "meter_period_snapshot",
              "action": "read",
              "tenantScoped": true,
              "idPath": "meterPeriodSnapshotId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Meter period snapshot",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Usage"
          ],
          "publicNoun": "Meter period snapshot",
          "resourceRef": "meter_period_snapshot",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "billing"
        ],
        "parameters": [
          {
            "name": "meterPeriodSnapshotId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.meterPeriodSnapshotRetrieve({\n  path: {\n    meterPeriodSnapshotId: \"mps_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeterPeriodSnapshotRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "meterPeriodSnapshotId": "mps_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies": {
      "post": {
        "operationId": "motor_policy_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Quote a motor policy",
        "description": "Opens the policy quote against a vehicle subject. No money moves until the policy binds.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "motor_policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "policyholderAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "insurerAccountId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "motor_policy.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Quote a motor policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.created",
            "operation": "motor_policy.create",
            "operationId": "motor_policy_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicyCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    policyholderAccountId: \"acct_sandbox_example0001\",\n    insurerAccountId: \"acct_sandbox_example0001\",\n    premiumAmount: \"1\",\n    coverageAmount: \"1\",\n    currency: \"SAR\",\n    expiresAt: \"2026-01-01T00:00:00.000Z\",\n    subject: \"sbj_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MotorPolicyCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "policyholderAccountId": "acct_sandbox_example0001",
                    "insurerAccountId": "acct_sandbox_example0001",
                    "premiumAmount": "1",
                    "coverageAmount": "1",
                    "currency": "SAR",
                    "expiresAt": "2026-01-01T00:00:00.000Z",
                    "subject": "sbj_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "motor_policy_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List motor policies",
        "description": "List motor policies",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "motor_policy:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List motor policies",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "quoted",
                "active",
                "claim_open",
                "settled",
                "denied",
                "expired",
                "canceled"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "policyholderAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "insurerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "premiumAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "premiumAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "coverageAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "coverageAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "expiresAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"quoted\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    policyholderAccountId: \"acct_sandbox_example0001\",\n    insurerAccountId: \"acct_sandbox_example0001\",\n    premiumAmountFrom: \"1\",\n    premiumAmountTo: \"1\",\n    coverageAmountFrom: \"1\",\n    coverageAmountTo: \"1\",\n    currency: \"SAR\",\n    expiresAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies/{motorPolicyId}": {
      "get": {
        "operationId": "motor_policy_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a motor policy",
        "description": "Retrieve a motor policy",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "motor_policy:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a motor policy",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyRetrieve({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "motor_policy_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a motor policy",
        "description": "Edits the mutable fields of a motor policy (coverageDescription) while it is quoted. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "motor_policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "motor_policy.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a motor policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.updated",
            "operation": "motor_policy.update",
            "operationId": "motor_policy_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicyUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyUpdate({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MotorPolicyUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies/{motorPolicyId}/bind": {
      "post": {
        "operationId": "motor_policy_bind",
        "tags": [
          "noun_instance"
        ],
        "summary": "Bind a motor policy",
        "description": "Underwrites the policy through an insurance carrier under a deadline, then settles the premium from the policyholder into the insurer account and puts the policy in force.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.bind",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "motor_policy:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.bound",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "commercial": {
            "earnable": true
          },
          "audit": {
            "event": "motor_policy.bound"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Bind a motor policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.bound",
            "operation": "motor_policy.bind",
            "operationId": "motor_policy_bind",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicyBindOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyBind({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyBindOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "active",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies/{motorPolicyId}/cancel": {
      "post": {
        "operationId": "motor_policy_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel a quoted motor policy",
        "description": "Closes a quote that never bound. No money has moved, so this is a pure lifecycle transition.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "motor_policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "motor_policy.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a quoted motor policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.canceled",
            "operation": "motor_policy.cancel",
            "operationId": "motor_policy_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicyCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyCancel({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "canceled",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies/{motorPolicyId}/deny-claim": {
      "post": {
        "operationId": "motor_policy_deny_claim",
        "tags": [
          "noun_instance"
        ],
        "summary": "Deny a motor claim",
        "description": "Denies the claim and voids the pending coverage hold, releasing the reserved amount back to the insurer account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.deny_claim",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "motor_policy:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.deny_claimed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "motor_policy.deny_claimed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Deny a motor claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.deny_claimed",
            "operation": "motor_policy.deny_claim",
            "operationId": "motor_policy_deny_claim",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicyDenyClaimOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyDenyClaim({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "destination_account_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyDenyClaimOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "denied",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies/{motorPolicyId}/open-claim": {
      "post": {
        "operationId": "motor_policy_open_claim",
        "tags": [
          "noun_instance"
        ],
        "summary": "Open a motor claim",
        "description": "Places a pending ledger hold for the coverage amount from the insurer account toward the policyholder. The insurer account must be capitalized to the coverage amount, or the hold is rejected for insufficient balance.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.open_claim",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "motor_policy:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.open_claimed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "motor_policy.open_claimed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Open a motor claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.open_claimed",
            "operation": "motor_policy.open_claim",
            "operationId": "motor_policy_open_claim",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicyOpenClaimOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicyOpenClaim({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_expiry_invalid",
          "transfer_expiry_past",
          "transfer_expiry_too_large",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicyOpenClaimOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "claim_open",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_expiry_invalid, transfer_expiry_past, transfer_expiry_too_large, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_expiry_invalid",
              "transfer_expiry_past",
              "transfer_expiry_too_large",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/motor-policies/{motorPolicyId}/settle-claim": {
      "post": {
        "operationId": "motor_policy_settle_claim",
        "tags": [
          "noun_instance"
        ],
        "summary": "Settle a motor claim",
        "description": "Approves the claim and posts the held coverage amount, settling the payout into the policyholder account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "motor_policy.settle_claim",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "motor_policy:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "motor_policy.claim_settled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "motorPolicyId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "motor_policy.claim_settled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Settle a motor claim",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Motor Policies"
          ],
          "publicNoun": "Motor policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "motor_policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "motor_policy.claim_settled",
            "operation": "motor_policy.settle_claim",
            "operationId": "motor_policy_settle_claim",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/MotorPolicySettleClaimOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "motorPolicyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.motorPolicySettleClaim({\n  path: {\n    motorPolicyId: \"mpol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_post_amount_invalid",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MotorPolicySettleClaimOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "motorPolicyId": "mpol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "motor_policy",
                      "status": "settled",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageAmount": "1",
                        "currency": "SAR",
                        "expiresAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "premiumTransferId": "resource_sandbox_example0001",
                        "claimTransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_post_amount_invalid, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_post_amount_invalid",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/operations": {
      "get": {
        "operationId": "operation_list",
        "tags": [
          "operation"
        ],
        "summary": "List Operations",
        "description": "List Operations as a cursor-paginated page. One recorded execution of a contract operation: what ran, for which company, and how it ended. Receipts, audit events, and money movements all point back at the operation row that produced them.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "operation.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "operation:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "operation.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "operation",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Operations",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Activity",
            "Operations"
          ],
          "publicNoun": "Operation",
          "resourceRef": "operation",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "accepted",
                "pending",
                "succeeded",
                "failed"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.operationList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"accepted\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OperationListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/operations/{operationId}": {
      "get": {
        "operationId": "operation_retrieve",
        "tags": [
          "operation"
        ],
        "summary": "Retrieve an Operation",
        "description": "Retrieve a single Operation by its operationId. One recorded execution of a contract operation: what ran, for which company, and how it ended. Receipts, audit events, and money movements all point back at the operation row that produced them.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "operation.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "operation:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "operation.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "operation",
              "action": "read",
              "tenantScoped": true,
              "idPath": "operationId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an Operation",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Activity",
            "Operations"
          ],
          "publicNoun": "Operation",
          "resourceRef": "operation",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "operationId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.operationRetrieve({\n  path: {\n    operationId: \"ops_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OperationRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "operationId": "ops_sandbox_example0001",
                        "name": "Sandbox account"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/orders": {
      "post": {
        "operationId": "order_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create an order",
        "description": "Records the proposed buyer and seller agreement against one listing and one escrow order. The escrow must still hold or await the money, must protect the same listing, and supplies the parties and the amount. No money moves.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "listingId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "escrowOrderId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "order.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create an order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "order.created",
            "operation": "order.create",
            "operationId": "order_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/OrderCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_marketplace01\",\n    subject: \"sbj_sandbox_landcruiser1\",\n    listingId: \"lst_sandbox_landcruiser1\",\n    escrowOrderId: \"eord_sandbox_buyerorder01\",\n    confirmBy: \"2026-08-01T20:00:00.000Z\",\n    memo: \"Purchase subject to funded escrow.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderCreateInput"
              },
              "examples": {
                "create_vehicle_purchase_order": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "listingId": "lst_sandbox_landcruiser1",
                    "escrowOrderId": "eord_sandbox_buyerorder01",
                    "confirmBy": "2026-08-01T20:00:00.000Z",
                    "memo": "Purchase subject to funded escrow."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "listingId": "lst_sandbox_landcruiser1",
                    "escrowOrderId": "eord_sandbox_buyerorder01",
                    "confirmBy": "2026-08-01T20:00:00.000Z",
                    "memo": "Purchase subject to funded escrow."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "orderId": "ord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "order",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "escrowOrderId": "eord_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "order_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List orders",
        "description": "List orders",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "order:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List orders",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "confirmed",
                "fulfilled",
                "canceled",
                "expired"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "buyerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "sellerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "listingId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^lst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Listing whose subject the buyer agreed to purchase"
            }
          },
          {
            "name": "escrowOrderId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^eord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Escrow order holding this order's purchase money"
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "confirmBy",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    buyerAccountId: \"acct_sandbox_example0001\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    listingId: \"lst_sandbox_example0001\",\n    escrowOrderId: \"eord_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    confirmBy: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/orders/{orderId}": {
      "get": {
        "operationId": "order_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve an order",
        "description": "Retrieve an order",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "order:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "orderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve an order",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderRetrieve({\n  path: {\n    orderId: \"ord_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "orderId": "ord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "order",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "escrowOrderId": "eord_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "order_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update an order",
        "description": "Edits the mutable fields of an order (confirmBy, memo) while it is created. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "orderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "order.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update an order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "order.updated",
            "operation": "order.update",
            "operationId": "order_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/OrderUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderUpdate({\n  path: {\n    orderId: \"ord_sandbox_landcruiser01\",\n  },\n  body: {\n    confirmBy: \"2026-08-01T20:00:00.000Z\",\n    memo: \"Buyer confirms after inspection.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrderUpdateBody"
              },
              "examples": {
                "annotate_unconfirmed_order": {
                  "value": {
                    "confirmBy": "2026-08-01T20:00:00.000Z",
                    "memo": "Buyer confirms after inspection."
                  }
                },
                "default": {
                  "value": {
                    "confirmBy": "2026-08-01T20:00:00.000Z",
                    "memo": "Buyer confirms after inspection."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "orderId": "ord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "order",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "escrowOrderId": "eord_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/orders/{orderId}/cancel": {
      "post": {
        "operationId": "order_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel an order",
        "description": "Closes the agreement only while escrow is still empty or after every held unit has safely returned to the buyer.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "orderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "order.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel an order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "order.canceled",
            "operation": "order.cancel",
            "operationId": "order_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/OrderCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderCancel({\n  path: {\n    orderId: \"ord_sandbox_landcruiser01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "orderId": "ord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "order",
                      "status": "canceled",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "escrowOrderId": "eord_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/orders/{orderId}/confirm": {
      "post": {
        "operationId": "order_confirm",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm an order",
        "description": "Makes the agreement final only while the listing is active at the agreed price and escrow holds the full purchase amount for that same listing.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.confirm",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "orderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "order.confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm an order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "order.confirmed",
            "operation": "order.confirm",
            "operationId": "order_confirm",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/OrderConfirmOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderConfirm({\n  path: {\n    orderId: \"ord_sandbox_landcruiser01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_incongruent",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderConfirmOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "orderId": "ord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "order",
                      "status": "confirmed",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "escrowOrderId": "eord_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_incongruent, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_incongruent",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/orders/{orderId}/fulfill": {
      "post": {
        "operationId": "order_fulfill",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fulfill an order",
        "description": "Closes the agreement after escrow has released the full purchase amount to the seller.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "order.fulfill",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "order:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "order.fulfilled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "orderId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "order.fulfilled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fulfill an order",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Orders"
          ],
          "publicNoun": "Order",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "order"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "order.fulfilled",
            "operation": "order.fulfill",
            "operationId": "order_fulfill",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/OrderFulfillOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^ord_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Order instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.orderFulfill({\n  path: {\n    orderId: \"ord_sandbox_landcruiser01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderFulfillOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "orderId": "ord_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "order",
                      "status": "fulfilled",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "listingId": "lst_sandbox_example0001",
                        "escrowOrderId": "eord_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/payout-runs": {
      "post": {
        "operationId": "payout_run_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Schedule a payout run",
        "description": "Opens one disbursement cycle for an earner with its declared net and withholding amounts. No money moves until withholding or execution.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout_run.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "payout_run:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout_run.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "earnerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "payoutFundingAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "withholdingAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "payout_run.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Schedule a payout run",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Payout Runs"
          ],
          "publicNoun": "Payout run",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payout_run"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "payout_run.created",
            "operation": "payout_run.create",
            "operationId": "payout_run_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PayoutRunCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRunCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    earnerAccountId: \"acct_sandbox_example0001\",\n    payoutFundingAccountId: \"acct_sandbox_example0001\",\n    withholdingAccountId: \"acct_sandbox_example0001\",\n    netAmount: \"1\",\n    withholdingAmount: \"1\",\n    currency: \"SAR\",\n    runAt: \"2026-01-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayoutRunCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "earnerAccountId": "acct_sandbox_example0001",
                    "payoutFundingAccountId": "acct_sandbox_example0001",
                    "withholdingAccountId": "acct_sandbox_example0001",
                    "netAmount": "1",
                    "withholdingAmount": "1",
                    "currency": "SAR",
                    "runAt": "2026-01-01T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRunCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "payoutRunId": "prun_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "payout_run",
                      "status": "scheduled",
                      "fields": {
                        "earnerAccountId": "acct_sandbox_example0001",
                        "payoutFundingAccountId": "acct_sandbox_example0001",
                        "withholdingAccountId": "acct_sandbox_example0001",
                        "netAmount": "1",
                        "withholdingAmount": "1",
                        "currency": "SAR",
                        "runAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "withholdingTransferId": "resource_sandbox_example0001",
                        "netTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "payout_run_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List payout runs",
        "description": "List payout runs",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout_run.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "payout_run:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout_run.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List payout runs",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Payout Runs"
          ],
          "publicNoun": "Payout run",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payout_run"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "scheduled",
                "withheld",
                "executed",
                "canceled"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "earnerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "payoutFundingAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "withholdingAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "netAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "netAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "withholdingAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "withholdingAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "runAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRunList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"scheduled\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    earnerAccountId: \"acct_sandbox_example0001\",\n    payoutFundingAccountId: \"acct_sandbox_example0001\",\n    withholdingAccountId: \"acct_sandbox_example0001\",\n    netAmountFrom: \"1\",\n    netAmountTo: \"1\",\n    withholdingAmountFrom: \"1\",\n    withholdingAmountTo: \"1\",\n    currency: \"SAR\",\n    runAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRunListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/payout-runs/{payoutRunId}": {
      "get": {
        "operationId": "payout_run_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a payout run",
        "description": "Retrieve a payout run",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout_run.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "payout_run:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout_run.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "payoutRunId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a payout run",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Payout Runs"
          ],
          "publicNoun": "Payout run",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payout_run"
        ],
        "parameters": [
          {
            "name": "payoutRunId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Payout run instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRunRetrieve({\n  path: {\n    payoutRunId: \"prun_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRunRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "payoutRunId": "prun_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "payout_run",
                      "status": "scheduled",
                      "fields": {
                        "earnerAccountId": "acct_sandbox_example0001",
                        "payoutFundingAccountId": "acct_sandbox_example0001",
                        "withholdingAccountId": "acct_sandbox_example0001",
                        "netAmount": "1",
                        "withholdingAmount": "1",
                        "currency": "SAR",
                        "runAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "withholdingTransferId": "resource_sandbox_example0001",
                        "netTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "payout_run_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a payout run",
        "description": "Edits the mutable fields of a payout run (memo) while it is scheduled. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout_run.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "payout_run:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout_run.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "payoutRunId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "payout_run.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a payout run",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Payout Runs"
          ],
          "publicNoun": "Payout run",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payout_run"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "payout_run.updated",
            "operation": "payout_run.update",
            "operationId": "payout_run_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PayoutRunUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "payoutRunId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Payout run instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRunUpdate({\n  path: {\n    payoutRunId: \"prun_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayoutRunUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRunUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "payoutRunId": "prun_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "payout_run",
                      "status": "scheduled",
                      "fields": {
                        "earnerAccountId": "acct_sandbox_example0001",
                        "payoutFundingAccountId": "acct_sandbox_example0001",
                        "withholdingAccountId": "acct_sandbox_example0001",
                        "netAmount": "1",
                        "withholdingAmount": "1",
                        "currency": "SAR",
                        "runAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "withholdingTransferId": "resource_sandbox_example0001",
                        "netTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/payout-runs/{payoutRunId}/cancel": {
      "post": {
        "operationId": "payout_run_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel a payout run",
        "description": "Closes a scheduled run before any money moves. Once withholding has settled the run is committed; a canceled run is a pure lifecycle exit.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout_run.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "payout_run:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout_run.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "payoutRunId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "payout_run.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a payout run",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Payout Runs"
          ],
          "publicNoun": "Payout run",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payout_run"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "payout_run.canceled",
            "operation": "payout_run.cancel",
            "operationId": "payout_run_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PayoutRunCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "payoutRunId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Payout run instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRunCancel({\n  path: {\n    payoutRunId: \"prun_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRunCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "payoutRunId": "prun_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "payout_run",
                      "status": "canceled",
                      "fields": {
                        "earnerAccountId": "acct_sandbox_example0001",
                        "payoutFundingAccountId": "acct_sandbox_example0001",
                        "withholdingAccountId": "acct_sandbox_example0001",
                        "netAmount": "1",
                        "withholdingAmount": "1",
                        "currency": "SAR",
                        "runAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "withholdingTransferId": "resource_sandbox_example0001",
                        "netTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/payout-runs/{payoutRunId}/withhold": {
      "post": {
        "operationId": "payout_run_withhold",
        "tags": [
          "noun_instance"
        ],
        "summary": "Withhold from a payout run",
        "description": "Settles the declared withholding amount from the earner's ledger account into the withholding reserve. Called when the desk's tax review resolves a rule that applies to this run; the amount is declared per run, never computed tax logic.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout_run.withhold",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "payout_run:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout_run.withheld",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "payoutRunId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "payout_run.withheld"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Withhold from a payout run",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Payout Runs"
          ],
          "publicNoun": "Payout run",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payout_run"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "payout_run.withheld",
            "operation": "payout_run.withhold",
            "operationId": "payout_run_withhold",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PayoutRunWithholdOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "payoutRunId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^prun_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Payout run instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRunWithhold({\n  path: {\n    payoutRunId: \"prun_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRunWithholdOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "payoutRunId": "prun_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "payout_run",
                      "status": "withheld",
                      "fields": {
                        "earnerAccountId": "acct_sandbox_example0001",
                        "payoutFundingAccountId": "acct_sandbox_example0001",
                        "withholdingAccountId": "acct_sandbox_example0001",
                        "netAmount": "1",
                        "withholdingAmount": "1",
                        "currency": "SAR",
                        "runAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "withholdingTransferId": "resource_sandbox_example0001",
                        "netTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/payouts": {
      "post": {
        "operationId": "payout_create",
        "tags": [
          "payout"
        ],
        "summary": "Create a payout",
        "description": "Creates a payout to an active beneficiary. The partner bank executes the transfer; Hyperscale instructs it, observes the outcome, and exposes progress only through the payout status and events.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "payout",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sourceAccountId"
            },
            {
              "kind": "beneficiary",
              "action": "read",
              "tenantScoped": true,
              "idPath": "beneficiaryId",
              "productBinding": "shared_tenant",
              "status": {
                "allowed": [
                  "active"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "payout.external.count",
            "meters": [
              "payout.external.count"
            ]
          },
          "audit": {
            "event": "payout.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a payout",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Payouts"
          ],
          "publicNoun": "Payout",
          "resourceRef": "payout",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payouts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "payout.created",
            "operation": "payout.create",
            "operationId": "payout_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PayoutCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutCreate({\n  body: {\n    sourceAccountId: \"acct_sandbox_seller0001\",\n    beneficiaryId: \"ben_sandbox_seller000001\",\n    amount: \"25000\",\n    currency: \"SAR\",\n    speed: \"standard\",\n    memo: \"Sold listing lst_sandbox_landcruiser1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "payout_beneficiary_reserved",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayoutCreateInput"
              },
              "examples": {
                "pay_marketplace_seller": {
                  "value": {
                    "sourceAccountId": "acct_sandbox_seller0001",
                    "beneficiaryId": "ben_sandbox_seller000001",
                    "amount": "25000",
                    "currency": "SAR",
                    "speed": "standard",
                    "memo": "Sold listing lst_sandbox_landcruiser1"
                  }
                },
                "default": {
                  "value": {
                    "sourceAccountId": "acct_sandbox_seller0001",
                    "beneficiaryId": "ben_sandbox_seller000001",
                    "amount": "25000",
                    "currency": "SAR",
                    "speed": "standard",
                    "memo": "Sold listing lst_sandbox_landcruiser1"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "payoutId": "pay_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "beneficiaryId": "ben_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "speed": "instant",
                      "status": "created",
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "metadata": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, customer_access_compliance_forbidden, operation_not_finalized, payout_beneficiary_reserved, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "customer_access_compliance_forbidden",
              "operation_not_finalized",
              "payout_beneficiary_reserved",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "payout_list",
        "tags": [
          "payout"
        ],
        "summary": "List Payouts",
        "description": "List Payouts as a cursor-paginated page. Money leaving Hyperscale to an active beneficiary, with execution details hidden behind honest statuses and events.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "payout:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "payout",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Payouts",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Payouts"
          ],
          "publicNoun": "Payout",
          "resourceRef": "payout",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payouts"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "processing",
                "completed",
                "failed",
                "returned"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"created\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/payouts/{payoutId}": {
      "get": {
        "operationId": "payout_retrieve",
        "tags": [
          "payout"
        ],
        "summary": "Retrieve a Payout",
        "description": "Retrieve a single Payout by its payoutId. Money leaving Hyperscale to an active beneficiary, with execution details hidden behind honest statuses and events.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "payout.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "payout:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "payout.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "payout",
              "action": "read",
              "tenantScoped": true,
              "idPath": "payoutId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Payout",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Money",
            "Payouts"
          ],
          "publicNoun": "Payout",
          "resourceRef": "payout",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "payouts"
        ],
        "parameters": [
          {
            "name": "payoutId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.payoutRetrieve({\n  path: {\n    payoutId: \"pay_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayoutRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "payoutId": "pay_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies": {
      "post": {
        "operationId": "policy_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Quote a policy",
        "description": "Creates a quote against one declared-value risk and provisions the premium reserve. No premium moves until the carrier binds.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.quoted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "policyholderAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "insurerAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "renewalOfPolicyId",
              "optional": true
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "policy.quoted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Quote a policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.quoted",
            "operation": "policy.create",
            "operationId": "policy_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_protection01\",\n    subject: \"sbj_sandbox_protection001\",\n    policyholderAccountId: \"acct_sandbox_holder00001\",\n    insurerAccountId: \"acct_sandbox_insurer0001\",\n    premiumAmount: \"12500\",\n    coverageLimit: \"200000\",\n    currency: \"SAR\",\n    startsAt: \"2026-08-01T00:00:00.000Z\",\n    expiresAt: \"2027-08-01T00:00:00.000Z\",\n    perilSchedule: [\n      {\n        peril: \"accidental_damage\",\n        limitAmount: \"200000\",\n        deductibleBps: 500,\n        waitingPeriodDays: 0,\n      },\n      {\n        peril: \"theft\",\n        limitAmount: \"200000\",\n        deductibleBps: 250,\n        waitingPeriodDays: 7,\n      },\n    ],\n    termsSummary: \"Annual cover for accidental damage and theft.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyCreateInput"
              },
              "examples": {
                "quote_asset_protection": {
                  "value": {
                    "workspaceId": "wsp_sandbox_protection01",
                    "subject": "sbj_sandbox_protection001",
                    "policyholderAccountId": "acct_sandbox_holder00001",
                    "insurerAccountId": "acct_sandbox_insurer0001",
                    "premiumAmount": "12500",
                    "coverageLimit": "200000",
                    "currency": "SAR",
                    "startsAt": "2026-08-01T00:00:00.000Z",
                    "expiresAt": "2027-08-01T00:00:00.000Z",
                    "perilSchedule": [
                      {
                        "peril": "accidental_damage",
                        "limitAmount": "200000",
                        "deductibleBps": 500,
                        "waitingPeriodDays": 0
                      },
                      {
                        "peril": "theft",
                        "limitAmount": "200000",
                        "deductibleBps": 250,
                        "waitingPeriodDays": 7
                      }
                    ],
                    "termsSummary": "Annual cover for accidental damage and theft."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_protection01",
                    "subject": "sbj_sandbox_protection001",
                    "policyholderAccountId": "acct_sandbox_holder00001",
                    "insurerAccountId": "acct_sandbox_insurer0001",
                    "premiumAmount": "12500",
                    "coverageLimit": "200000",
                    "currency": "SAR",
                    "startsAt": "2026-08-01T00:00:00.000Z",
                    "expiresAt": "2027-08-01T00:00:00.000Z",
                    "perilSchedule": [
                      {
                        "peril": "accidental_damage",
                        "limitAmount": "200000",
                        "deductibleBps": 500,
                        "waitingPeriodDays": 0
                      },
                      {
                        "peril": "theft",
                        "limitAmount": "200000",
                        "deductibleBps": 250,
                        "waitingPeriodDays": 7
                      }
                    ],
                    "termsSummary": "Annual cover for accidental damage and theft."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "policy_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List policies",
        "description": "List policies",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "policy:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List policies",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "quoted",
                "bound",
                "active",
                "cancel_quoted",
                "canceled",
                "expired"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "policyholderAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "insurerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "premiumAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "premiumAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "coverageLimitFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "coverageLimitTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "startsAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "expiresAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "renewalOfPolicyId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Prior policy this quote renews; the prior term must be active or already expired"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"quoted\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    policyholderAccountId: \"acct_sandbox_example0001\",\n    insurerAccountId: \"acct_sandbox_example0001\",\n    premiumAmountFrom: \"1\",\n    premiumAmountTo: \"1\",\n    coverageLimitFrom: \"1\",\n    coverageLimitTo: \"1\",\n    currency: \"SAR\",\n    startsAt: \"2026-01-01T00:00:00.000Z\",\n    expiresAt: \"2026-01-01T00:00:00.000Z\",\n    renewalOfPolicyId: \"pol_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies/{policyId}": {
      "get": {
        "operationId": "policy_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a policy",
        "description": "Retrieve a policy",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "policy:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "policyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a policy",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyRetrieve({\n  path: {\n    policyId: \"pol_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "policy_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a policy",
        "description": "Edits the mutable fields of a policy (startsAt, expiresAt, perilSchedule, termsSummary) while it is quoted. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "policyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "policy.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.updated",
            "operation": "policy.update",
            "operationId": "policy_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyUpdate({\n  path: {\n    policyId: \"pol_sandbox_protection001\",\n  },\n  body: {\n    termsSummary: \"Covers accidental damage and theft.\",\n    perilSchedule: [\n      {\n        peril: \"accidental_damage\",\n        limitAmount: \"200000\",\n        deductibleBps: 500,\n        waitingPeriodDays: 0,\n      },\n      {\n        peril: \"theft\",\n        limitAmount: \"200000\",\n        deductibleBps: 250,\n        waitingPeriodDays: 7,\n      },\n    ],\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyUpdateBody"
              },
              "examples": {
                "refine_quoted_cover": {
                  "value": {
                    "termsSummary": "Covers accidental damage and theft.",
                    "perilSchedule": [
                      {
                        "peril": "accidental_damage",
                        "limitAmount": "200000",
                        "deductibleBps": 500,
                        "waitingPeriodDays": 0
                      },
                      {
                        "peril": "theft",
                        "limitAmount": "200000",
                        "deductibleBps": 250,
                        "waitingPeriodDays": 7
                      }
                    ]
                  }
                },
                "default": {
                  "value": {
                    "termsSummary": "Covers accidental damage and theft.",
                    "perilSchedule": [
                      {
                        "peril": "accidental_damage",
                        "limitAmount": "200000",
                        "deductibleBps": 500,
                        "waitingPeriodDays": 0
                      },
                      {
                        "peril": "theft",
                        "limitAmount": "200000",
                        "deductibleBps": 250,
                        "waitingPeriodDays": 7
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies/{policyId}/bind": {
      "post": {
        "operationId": "policy_bind",
        "tags": [
          "noun_instance"
        ],
        "summary": "Bind a policy",
        "description": "Asks the carrier to accept the risk, then moves the premium into its dedicated reserve until cover starts.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.bind",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "policy:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.bound",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "policyId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "policy.bound"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Bind a policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.bound",
            "operation": "policy.bind",
            "operationId": "policy_bind",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyBindOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyBind({\n  path: {\n    policyId: \"pol_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyBindOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "bound",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_decision_declined, noun_decision_timeout, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies/{policyId}/cancel": {
      "post": {
        "operationId": "policy_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel a policy",
        "description": "Confirms the previewed cancellation and returns the entire reserved premium to the policyholder before cover starts.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "policy:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "policyId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "policy.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.canceled",
            "operation": "policy.cancel",
            "operationId": "policy_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyCancel({\n  path: {\n    policyId: \"pol_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "canceled",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies/{policyId}/endorse": {
      "post": {
        "operationId": "policy_endorse",
        "tags": [
          "noun_instance"
        ],
        "summary": "Endorse a policy",
        "description": "Applies a carrier-approved mid-term change to active cover: the peril schedule, terms summary, or expiry may be rewritten. No premium moves; mid-term premium adjustment is not modeled.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.endorse",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.endorsed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "policyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "policy.endorsed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Endorse a policy",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.endorsed",
            "operation": "policy.endorse",
            "operationId": "policy_endorse",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyEndorseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyEndorse({\n  path: {\n    policyId: \"pol_sandbox_protection001\",\n  },\n  body: {\n    termsSummary: \"Extended cover incl. water damage.\",\n    expiresAt: \"2027-11-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_decision_declined",
          "noun_decision_timeout",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PolicyEndorseBody"
              },
              "examples": {
                "endorse_extend_active_cover": {
                  "value": {
                    "termsSummary": "Extended cover incl. water damage.",
                    "expiresAt": "2027-11-01T00:00:00.000Z"
                  }
                },
                "default": {
                  "value": {
                    "termsSummary": "Extended cover incl. water damage.",
                    "expiresAt": "2027-11-01T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyEndorseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "active",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_decision_declined, noun_decision_timeout, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_decision_declined",
              "noun_decision_timeout",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies/{policyId}/preview": {
      "post": {
        "operationId": "policy_preview",
        "tags": [
          "noun_instance"
        ],
        "summary": "Preview policy cancellation",
        "description": "Quotes the full premium refund while cover is bound but not active. No money moves until cancellation is confirmed.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.preview",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.previewed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "policyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "policy.previewed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Preview policy cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.previewed",
            "operation": "policy.preview",
            "operationId": "policy_preview",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyPreviewOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyPreview({\n  path: {\n    policyId: \"pol_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyPreviewOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "cancel_quoted",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/policies/{policyId}/withdraw": {
      "post": {
        "operationId": "policy_withdraw",
        "tags": [
          "noun_instance"
        ],
        "summary": "Withdraw a policy quote",
        "description": "Closes an unbound quote. No premium moved, so no cancellation preview is required.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "policy.withdraw",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "policy:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "policy.withdrawn",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "policyId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "policy.withdrawn"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Withdraw a policy quote",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Policies"
          ],
          "publicNoun": "Policy",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "policy"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "policy.withdrawn",
            "operation": "policy.withdraw",
            "operationId": "policy_withdraw",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/PolicyWithdrawOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "policyId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^pol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Policy instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.policyWithdraw({\n  path: {\n    policyId: \"pol_sandbox_protection001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PolicyWithdrawOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "policyId": "pol_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "policy",
                      "status": "canceled",
                      "fields": {
                        "policyholderAccountId": "acct_sandbox_example0001",
                        "insurerAccountId": "acct_sandbox_example0001",
                        "premiumAmount": "1",
                        "coverageLimit": "1",
                        "currency": "SAR",
                        "startsAt": "2026-01-01T00:00:00.000Z",
                        "expiresAt": "2026-01-01T00:00:00.000Z",
                        "perilSchedule": [
                          {
                            "peril": "customer_request",
                            "limitAmount": "1",
                            "deductibleBps": 0,
                            "waitingPeriodDays": 0
                          }
                        ]
                      },
                      "refs": {
                        "premiumReserveAccountId": "acct_sandbox_example0001",
                        "premiumFundingTransferId": "resource_sandbox_example0001",
                        "premiumTransferId": "resource_sandbox_example0001",
                        "premiumRefundTransferId": "ref_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/products": {
      "get": {
        "operationId": "product_list",
        "tags": [
          "workspace"
        ],
        "summary": "List your Products",
        "description": "List the Products in your company with their optional Blueprint, plan tier, and status.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "product.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List your Products",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Products"
          ],
          "publicNoun": "Product",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "workspaces"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "pending",
                "active",
                "disabled",
                "closed"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.productList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"pending\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/products/{workspaceId}": {
      "get": {
        "operationId": "product_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve a Product",
        "description": "Retrieve a Product joined with its optional Blueprint, plan tier, go-live readiness and cost, and generated developer surfaces.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "product.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Product",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Products"
          ],
          "publicNoun": "Product",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "workspaces"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.productRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_escrowmarket01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_build_not_found"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductRetrieveOutput"
                },
                "examples": {
                  "Sandbox Product summary": {
                    "value": {
                      "workspaceId": "wsp_sandbox_escrowmarket01",
                      "tenantId": "ten_sandbox_founderco01",
                      "environment": "sandbox",
                      "displayName": "Vehicle Escrow Marketplace",
                      "slug": "vehicle-escrow-marketplace",
                      "kind": "offering",
                      "status": "active",
                      "blueprint": {
                        "id": "vehicle-escrow-marketplace",
                        "name": "Vehicle Escrow Marketplace"
                      },
                      "nounIds": [
                        "vehicle_listing",
                        "vehicle_escrow"
                      ],
                      "plan": {
                        "monthlySar": "1000",
                        "setupSar": "5000",
                        "complexityScore": 0,
                        "rates": []
                      },
                      "readiness": {
                        "live": false,
                        "outstandingLiveRequirements": [
                          "bank_letter",
                          "live_ledger_partition"
                        ],
                        "liveUnavailableCapabilities": []
                      },
                      "capabilities": [
                        {
                          "capabilityId": "accounts",
                          "name": "Accounts"
                        }
                      ],
                      "cost": {
                        "currency": "SAR",
                        "platformMonthlySar": "1000",
                        "platformSetupSar": "5000",
                        "liveCapableCount": 0,
                        "recurringCharges": [],
                        "usageCharges": [],
                        "estimatedMonthlyFixedSar": "1000",
                        "blockers": [],
                        "complete": true
                      },
                      "surfaces": {
                        "graphql": {
                          "artifactType": "graphql_schema",
                          "environment": "sandbox",
                          "activationRequired": false,
                          "requiredAction": "none",
                          "url": "/v1/graphql"
                        },
                        "mcp": {
                          "artifactType": "mcp",
                          "environment": "sandbox",
                          "activationRequired": false,
                          "requiredAction": "none",
                          "url": "/v1/mcp?capabilityIds=accounts"
                        },
                        "openapi": {
                          "artifactType": "openapi_spec",
                          "environment": "sandbox",
                          "activationRequired": false,
                          "requiredAction": "none",
                          "url": "/v1/workspaces/wsp_sandbox_escrowmarket01/openapi.json"
                        },
                        "sdk": {
                          "artifactType": "sdk_kit",
                          "environment": "sandbox",
                          "activationRequired": false,
                          "requiredAction": "none",
                          "url": "/v1/workspaces/wsp_sandbox_escrowmarket01/kit"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_build_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_build_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/receipts": {
      "get": {
        "operationId": "receipt_list",
        "tags": [
          "receipt"
        ],
        "summary": "List Receipts",
        "description": "List Receipts as a cursor-paginated page. The durable proof that an operation completed: what ran, for which company, and the terminal outcome. An operation that promises a receipt is not finished until one exists.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "receipt.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "receipt:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "receipt.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "receipt",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Receipts",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Activity",
            "Operations"
          ],
          "publicNoun": "Receipt",
          "resourceRef": "receipt",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.receiptList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReceiptListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/receipts/{receiptId}": {
      "get": {
        "operationId": "receipt_retrieve",
        "tags": [
          "receipt"
        ],
        "summary": "Retrieve a Receipt",
        "description": "Retrieve a single Receipt by its receiptId. The durable proof that an operation completed: what ran, for which company, and the terminal outcome. An operation that promises a receipt is not finished until one exists.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "receipt.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "receipt:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "receipt.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "receipt",
              "action": "read",
              "tenantScoped": true,
              "idPath": "receiptId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Receipt",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Activity",
            "Operations"
          ],
          "publicNoun": "Receipt",
          "resourceRef": "receipt",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "activity"
        ],
        "parameters": [
          {
            "name": "receiptId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.receiptRetrieve({\n  path: {\n    receiptId: \"rcp_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReceiptRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "receiptId": "rcp_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements": {
      "post": {
        "operationId": "sale_settlement_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a sale settlement",
        "description": "Opens the settlement and provisions its dedicated product escrow account. The piece amounts must partition the price exactly: a create whose pieces do not sum to the price is refused.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "buyerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sellerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "platformAccountId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "sale_settlement.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.created",
            "operation": "sale_settlement.create",
            "operationId": "sale_settlement_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_marketplace01\",\n    subject: \"sbj_sandbox_landcruiser1\",\n    buyerAccountId: \"acct_sandbox_buyer000001\",\n    sellerAccountId: \"acct_sandbox_seller00001\",\n    platformAccountId: \"acct_sandbox_platfees001\",\n    price: \"250000\",\n    piece1Amount: \"245000\",\n    piece2Amount: \"3750\",\n    piece3Amount: \"1250\",\n    serviceFeeAmount: \"2500\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_partition_mismatch",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SaleSettlementCreateInput"
              },
              "examples": {
                "open_car_sale_settlement": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "buyerAccountId": "acct_sandbox_buyer000001",
                    "sellerAccountId": "acct_sandbox_seller00001",
                    "platformAccountId": "acct_sandbox_platfees001",
                    "price": "250000",
                    "piece1Amount": "245000",
                    "piece2Amount": "3750",
                    "piece3Amount": "1250",
                    "serviceFeeAmount": "2500",
                    "currency": "SAR"
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace01",
                    "subject": "sbj_sandbox_landcruiser1",
                    "buyerAccountId": "acct_sandbox_buyer000001",
                    "sellerAccountId": "acct_sandbox_seller00001",
                    "platformAccountId": "acct_sandbox_platfees001",
                    "price": "250000",
                    "piece1Amount": "245000",
                    "piece2Amount": "3750",
                    "piece3Amount": "1250",
                    "serviceFeeAmount": "2500",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementCreateOutput"
                },
                "examples": {
                  "open_car_sale_settlement": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:30:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_partition_mismatch, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_partition_mismatch",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "sale_settlement_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List sale settlements",
        "description": "List sale settlements",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "sale_settlement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List sale settlements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "funding_1",
                "funding_2",
                "funding_3",
                "funded",
                "releasing_1",
                "releasing_2",
                "released",
                "cancelling_1",
                "cancelling_2",
                "cancelled",
                "abandoning_2",
                "abandoning_1",
                "abandoned"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "buyerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "sellerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "platformAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Account that collects the settlement's declared fees: the workspace revenue account or a customer balance account",
              "x-hyperscale-fee-collection-port": true,
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance",
                  "workspace_revenue"
                ]
              }
            }
          },
          {
            "name": "priceFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "priceTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "piece1AmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "piece1AmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "piece2AmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "piece2AmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "piece3AmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "piece3AmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "serviceFeeAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "serviceFeeAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    buyerAccountId: \"acct_sandbox_example0001\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    platformAccountId: \"acct_sandbox_example0001\",\n    priceFrom: \"1\",\n    priceTo: \"1\",\n    piece1AmountFrom: \"1\",\n    piece1AmountTo: \"1\",\n    piece2AmountFrom: \"1\",\n    piece2AmountTo: \"1\",\n    piece3AmountFrom: \"1\",\n    piece3AmountTo: \"1\",\n    serviceFeeAmountFrom: \"1\",\n    serviceFeeAmountTo: \"1\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}": {
      "get": {
        "operationId": "sale_settlement_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a sale settlement",
        "description": "Retrieve a sale settlement",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "sale_settlement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a sale settlement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementRetrieve({\n  path: {\n    saleSettlementId: \"sale_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "sale_settlement",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "price": "1",
                        "piece1Amount": "1",
                        "piece2Amount": "1",
                        "piece3Amount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundPiece1TransferId": "resource_sandbox_example0001",
                        "fundPiece2TransferId": "resource_sandbox_example0001",
                        "fundPiece3TransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releasePiece1TransferId": "resource_sandbox_example0001",
                        "releasePiece2TransferId": "resource_sandbox_example0001",
                        "releasePiece3TransferId": "resource_sandbox_example0001",
                        "cancelPiece1TransferId": "resource_sandbox_example0001",
                        "refundPiece2TransferId": "ref_sandbox_example0001",
                        "refundPiece3TransferId": "ref_sandbox_example0001",
                        "unfundPiece3TransferId": "resource_sandbox_example0001",
                        "unfundPiece2TransferId": "resource_sandbox_example0001",
                        "unfundPiece1TransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/abandon": {
      "post": {
        "operationId": "sale_settlement_abandon",
        "tags": [
          "noun_instance"
        ],
        "summary": "Abandon an unfunded sale settlement",
        "description": "Closes a settlement no money has entered: an abandoned checkout ends here instead of staying open forever. Nothing is held at created, so nothing moves. A partially funded settlement first returns its held pieces through the unfund chain and lands here through the last unfund.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.abandon",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "sale_settlement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.abandoned",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "sale_settlement.abandoned"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Abandon an unfunded sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.abandoned",
            "operation": "sale_settlement.abandon",
            "operationId": "sale_settlement_abandon",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementAbandonOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementAbandon({\n  path: {\n    saleSettlementId: \"sale_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementAbandonOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "sale_settlement",
                      "status": "abandoned",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "price": "1",
                        "piece1Amount": "1",
                        "piece2Amount": "1",
                        "piece3Amount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundPiece1TransferId": "resource_sandbox_example0001",
                        "fundPiece2TransferId": "resource_sandbox_example0001",
                        "fundPiece3TransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releasePiece1TransferId": "resource_sandbox_example0001",
                        "releasePiece2TransferId": "resource_sandbox_example0001",
                        "releasePiece3TransferId": "resource_sandbox_example0001",
                        "cancelPiece1TransferId": "resource_sandbox_example0001",
                        "refundPiece2TransferId": "ref_sandbox_example0001",
                        "refundPiece3TransferId": "ref_sandbox_example0001",
                        "unfundPiece3TransferId": "resource_sandbox_example0001",
                        "unfundPiece2TransferId": "resource_sandbox_example0001",
                        "unfundPiece1TransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/cancel": {
      "post": {
        "operationId": "sale_settlement_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel a sale settlement",
        "description": "Starts the cancellation unwind of a fully funded settlement by returning the first held piece from escrow to the buyer. The on-top service fee is not returned.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.cancelled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.cancelled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.cancelled",
            "operation": "sale_settlement.cancel",
            "operationId": "sale_settlement_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementCancel({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementCancelOutput"
                },
                "examples": {
                  "cancel_funded_settlement": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "cancelling_1",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01",
                        "cancelPiece1TransferId": "trn_sandbox_cancel000001"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:35:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/collect-service-fee": {
      "post": {
        "operationId": "sale_settlement_collect_service_fee",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect the sale settlement service fee",
        "description": "Charges the buyer-side service fee on top of the held price, straight from the buyer to the platform fee account. The fee never enters escrow, so it is non-refundable by construction. Reaching funded is the tenant backend's cue to rule on handover through the release port.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.collect_service_fee",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.service_fee_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.service_fee_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect the sale settlement service fee",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.service_fee_collected",
            "operation": "sale_settlement.collect_service_fee",
            "operationId": "sale_settlement_collect_service_fee",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementCollectServiceFeeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementCollectServiceFee({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementCollectServiceFeeOutput"
                },
                "examples": {
                  "collect_service_fee": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "funded",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:34:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/confirm-handover": {
      "post": {
        "operationId": "sale_settlement_confirm_handover",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm handover of a sale settlement",
        "description": "The release decision port: the tenant's own backend rules that handover happened and asserts the buyer as the acting party. Starts the release by paying the seller's piece out of escrow.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.confirm_handover",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.handover_confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.handover_confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm handover of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.handover_confirmed",
            "operation": "sale_settlement.confirm_handover",
            "operationId": "sale_settlement_confirm_handover",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementConfirmHandoverOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementConfirmHandover({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n  body: {\n    actorAccountId: \"acct_sandbox_buyer000001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "port_actor_not_allowed",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SaleSettlementConfirmHandoverBody"
              },
              "examples": {
                "confirm_handover_as_buyer": {
                  "value": {
                    "actorAccountId": "acct_sandbox_buyer000001"
                  }
                },
                "default": {
                  "value": {
                    "actorAccountId": "acct_sandbox_buyer000001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementConfirmHandoverOutput"
                },
                "examples": {
                  "confirm_handover_as_buyer": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "releasing_1",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01",
                        "releasePiece1TransferId": "trn_sandbox_release00001"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:35:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, port_actor_not_allowed, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "port_actor_not_allowed",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/fund-piece-1": {
      "post": {
        "operationId": "sale_settlement_fund_piece_1",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund piece 1 of a sale settlement",
        "description": "Moves the first held piece from the buyer into the dedicated escrow account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.fund_piece_1",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_1_funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_1_funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund piece 1 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_1_funded",
            "operation": "sale_settlement.fund_piece_1",
            "operationId": "sale_settlement_fund_piece_1",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementFundPiece1Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementFundPiece1({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementFundPiece1Output"
                },
                "examples": {
                  "fund_first_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "funding_1",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:31:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/fund-piece-2": {
      "post": {
        "operationId": "sale_settlement_fund_piece_2",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund piece 2 of a sale settlement",
        "description": "Moves the second held piece from the buyer into the dedicated escrow account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.fund_piece_2",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_2_funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_2_funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund piece 2 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_2_funded",
            "operation": "sale_settlement.fund_piece_2",
            "operationId": "sale_settlement_fund_piece_2",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementFundPiece2Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementFundPiece2({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementFundPiece2Output"
                },
                "examples": {
                  "fund_second_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "funding_2",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:32:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/fund-piece-3": {
      "post": {
        "operationId": "sale_settlement_fund_piece_3",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund piece 3 of a sale settlement",
        "description": "Moves the third held piece from the buyer into the dedicated escrow account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.fund_piece_3",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_3_funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_3_funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund piece 3 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_3_funded",
            "operation": "sale_settlement.fund_piece_3",
            "operationId": "sale_settlement_fund_piece_3",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementFundPiece3Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementFundPiece3({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementFundPiece3Output"
                },
                "examples": {
                  "fund_third_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "funding_3",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:33:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/refund-piece-2": {
      "post": {
        "operationId": "sale_settlement_refund_piece_2",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund piece 2 of a sale settlement",
        "description": "Returns the second held piece from escrow to the buyer on cancellation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.refund_piece_2",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_2_refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_2_refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund piece 2 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_2_refunded",
            "operation": "sale_settlement.refund_piece_2",
            "operationId": "sale_settlement_refund_piece_2",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementRefundPiece2Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementRefundPiece2({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementRefundPiece2Output"
                },
                "examples": {
                  "refund_second_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "cancelling_2",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01",
                        "cancelPiece1TransferId": "trn_sandbox_cancel000001",
                        "refundPiece2TransferId": "trn_sandbox_refund000002"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:36:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/refund-piece-3": {
      "post": {
        "operationId": "sale_settlement_refund_piece_3",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund piece 3 of a sale settlement",
        "description": "Pays the last held piece from escrow to the seller on cancellation -- the program's declared cancel split -- draining the escrow exactly and closing the settlement as cancelled.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.refund_piece_3",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_3_refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_3_refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund piece 3 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_3_refunded",
            "operation": "sale_settlement.refund_piece_3",
            "operationId": "sale_settlement_refund_piece_3",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementRefundPiece3Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementRefundPiece3({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementRefundPiece3Output"
                },
                "examples": {
                  "refund_last_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "cancelled",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01",
                        "cancelPiece1TransferId": "trn_sandbox_cancel000001",
                        "refundPiece2TransferId": "trn_sandbox_refund000002",
                        "refundPiece3TransferId": "trn_sandbox_refund000003"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:37:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/release-piece-2": {
      "post": {
        "operationId": "sale_settlement_release_piece_2",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release piece 2 of a sale settlement",
        "description": "Pays the second fee piece from escrow to the platform fee account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.release_piece_2",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_2_released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_2_released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release piece 2 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_2_released",
            "operation": "sale_settlement.release_piece_2",
            "operationId": "sale_settlement_release_piece_2",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementReleasePiece2Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementReleasePiece2({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementReleasePiece2Output"
                },
                "examples": {
                  "release_second_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "releasing_2",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01",
                        "releasePiece1TransferId": "trn_sandbox_release00001",
                        "releasePiece2TransferId": "trn_sandbox_release00002"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:36:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/release-piece-3": {
      "post": {
        "operationId": "sale_settlement_release_piece_3",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release piece 3 of a sale settlement",
        "description": "Pays the last fee piece from escrow to the platform fee account, draining the escrow exactly and closing the settlement as released.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.release_piece_3",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_3_released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_3_released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release piece 3 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_3_released",
            "operation": "sale_settlement.release_piece_3",
            "operationId": "sale_settlement_release_piece_3",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementReleasePiece3Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementReleasePiece3({\n  path: {\n    saleSettlementId: \"sale_sandbox_carorder0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementReleasePiece3Output"
                },
                "examples": {
                  "release_last_piece": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_carorder0001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace01",
                      "nounId": "sale_settlement",
                      "status": "released",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_buyer000001",
                        "sellerAccountId": "acct_sandbox_seller00001",
                        "platformAccountId": "acct_sandbox_platfees001",
                        "price": "250000",
                        "piece1Amount": "245000",
                        "piece2Amount": "3750",
                        "piece3Amount": "1250",
                        "serviceFeeAmount": "2500",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_landcruiser1",
                        "escrowAccountId": "acct_sandbox_saleescrow1",
                        "fundPiece1TransferId": "trn_sandbox_fundpiece001",
                        "fundPiece2TransferId": "trn_sandbox_fundpiece002",
                        "fundPiece3TransferId": "trn_sandbox_fundpiece003",
                        "serviceFeeTransferId": "trn_sandbox_servicefee01",
                        "releasePiece1TransferId": "trn_sandbox_release00001",
                        "releasePiece2TransferId": "trn_sandbox_release00002",
                        "releasePiece3TransferId": "trn_sandbox_release00003"
                      },
                      "createdAt": "2026-07-20T09:30:00.000Z",
                      "updatedAt": "2026-07-20T09:37:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/unfund-piece-1": {
      "post": {
        "operationId": "sale_settlement_unfund_piece_1",
        "tags": [
          "noun_instance"
        ],
        "summary": "Unfund piece 1 of a sale settlement",
        "description": "Returns the first held piece from escrow to the buyer, draining the escrow exactly and closing the settlement as abandoned.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.unfund_piece_1",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_1_unfunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_1_unfunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Unfund piece 1 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_1_unfunded",
            "operation": "sale_settlement.unfund_piece_1",
            "operationId": "sale_settlement_unfund_piece_1",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementUnfundPiece1Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementUnfundPiece1({\n  path: {\n    saleSettlementId: \"sale_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementUnfundPiece1Output"
                },
                "examples": {
                  "default": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "sale_settlement",
                      "status": "abandoned",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "price": "1",
                        "piece1Amount": "1",
                        "piece2Amount": "1",
                        "piece3Amount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundPiece1TransferId": "resource_sandbox_example0001",
                        "fundPiece2TransferId": "resource_sandbox_example0001",
                        "fundPiece3TransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releasePiece1TransferId": "resource_sandbox_example0001",
                        "releasePiece2TransferId": "resource_sandbox_example0001",
                        "releasePiece3TransferId": "resource_sandbox_example0001",
                        "cancelPiece1TransferId": "resource_sandbox_example0001",
                        "refundPiece2TransferId": "ref_sandbox_example0001",
                        "refundPiece3TransferId": "ref_sandbox_example0001",
                        "unfundPiece3TransferId": "resource_sandbox_example0001",
                        "unfundPiece2TransferId": "resource_sandbox_example0001",
                        "unfundPiece1TransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/unfund-piece-2": {
      "post": {
        "operationId": "sale_settlement_unfund_piece_2",
        "tags": [
          "noun_instance"
        ],
        "summary": "Unfund piece 2 of a sale settlement",
        "description": "Returns the second held piece from escrow to the buyer on abandonment of a partially funded settlement.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.unfund_piece_2",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_2_unfunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_2_unfunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Unfund piece 2 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_2_unfunded",
            "operation": "sale_settlement.unfund_piece_2",
            "operationId": "sale_settlement_unfund_piece_2",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementUnfundPiece2Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementUnfundPiece2({\n  path: {\n    saleSettlementId: \"sale_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementUnfundPiece2Output"
                },
                "examples": {
                  "default": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "sale_settlement",
                      "status": "abandoning_1",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "price": "1",
                        "piece1Amount": "1",
                        "piece2Amount": "1",
                        "piece3Amount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundPiece1TransferId": "resource_sandbox_example0001",
                        "fundPiece2TransferId": "resource_sandbox_example0001",
                        "fundPiece3TransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releasePiece1TransferId": "resource_sandbox_example0001",
                        "releasePiece2TransferId": "resource_sandbox_example0001",
                        "releasePiece3TransferId": "resource_sandbox_example0001",
                        "cancelPiece1TransferId": "resource_sandbox_example0001",
                        "refundPiece2TransferId": "ref_sandbox_example0001",
                        "refundPiece3TransferId": "ref_sandbox_example0001",
                        "unfundPiece3TransferId": "resource_sandbox_example0001",
                        "unfundPiece2TransferId": "resource_sandbox_example0001",
                        "unfundPiece1TransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sale-settlements/{saleSettlementId}/unfund-piece-3": {
      "post": {
        "operationId": "sale_settlement_unfund_piece_3",
        "tags": [
          "noun_instance"
        ],
        "summary": "Unfund piece 3 of a sale settlement",
        "description": "Returns the third held piece from escrow to the buyer, starting the abandonment of a partially funded settlement. Each unfund reverses exactly one funding movement; the service fee is never owed because it moves only on the transition into funded.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sale_settlement.unfund_piece_3",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "sale_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sale_settlement.piece_3_unfunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "saleSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "sale_settlement.piece_3_unfunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Unfund piece 3 of a sale settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Sale Settlements"
          ],
          "publicNoun": "Sale settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "sale_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sale_settlement.piece_3_unfunded",
            "operation": "sale_settlement.unfund_piece_3",
            "operationId": "sale_settlement_unfund_piece_3",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SaleSettlementUnfundPiece3Output"
            }
          }
        ],
        "parameters": [
          {
            "name": "saleSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^sale_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Sale settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.saleSettlementUnfundPiece3({\n  path: {\n    saleSettlementId: \"sale_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SaleSettlementUnfundPiece3Output"
                },
                "examples": {
                  "default": {
                    "value": {
                      "saleSettlementId": "sale_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "sale_settlement",
                      "status": "abandoning_2",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "price": "1",
                        "piece1Amount": "1",
                        "piece2Amount": "1",
                        "piece3Amount": "1",
                        "serviceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundPiece1TransferId": "resource_sandbox_example0001",
                        "fundPiece2TransferId": "resource_sandbox_example0001",
                        "fundPiece3TransferId": "resource_sandbox_example0001",
                        "serviceFeeTransferId": "resource_sandbox_example0001",
                        "releasePiece1TransferId": "resource_sandbox_example0001",
                        "releasePiece2TransferId": "resource_sandbox_example0001",
                        "releasePiece3TransferId": "resource_sandbox_example0001",
                        "cancelPiece1TransferId": "resource_sandbox_example0001",
                        "refundPiece2TransferId": "ref_sandbox_example0001",
                        "refundPiece3TransferId": "ref_sandbox_example0001",
                        "unfundPiece3TransferId": "resource_sandbox_example0001",
                        "unfundPiece2TransferId": "resource_sandbox_example0001",
                        "unfundPiece1TransferId": "resource_sandbox_example0001",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sandbox/account-funding": {
      "post": {
        "operationId": "sandbox_account_fund",
        "tags": [
          "sandbox_account_funding"
        ],
        "summary": "Fund a sandbox account",
        "description": "Posts a settled credit into a sandbox account from a system funding source so developers can seed test balances themselves. Self-serve with a product API key or portal session and confined to the sandbox environment; it never moves live money.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sandbox.account.fund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "sandbox",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sandbox.account.funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "destinationAccountId"
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "amountPath": "amount",
            "currencyPath": "currency",
            "deterministicTransferId": "operation",
            "destinationAccountIdPath": "destinationAccountId",
            "lineage": "none",
            "transferSemantics": "post"
          },
          "metering": {},
          "audit": {
            "event": "sandbox.account.funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund a sandbox account",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Developer",
            "Sandbox"
          ],
          "publicNoun": "Sandbox account funding",
          "resourceRef": "sandbox_account_funding",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "internal_transfers"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sandbox.account.funded",
            "operation": "sandbox.account.fund",
            "operationId": "sandbox_account_fund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SandboxAccountFundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "X-Hyperscale-Environment",
            "in": "header",
            "description": "This operation is pinned to the sandbox environment; any other value is refused with `operation_environment_invalid`. Omitted requests already run in sandbox.",
            "required": false,
            "schema": {
              "type": "string",
              "const": "sandbox"
            }
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.sandboxAccountFund({\n  body: {\n    destinationAccountId: \"acct_sandbox_example0001\",\n    amount: \"1\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "funding_destination_role_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_environment_invalid",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SandboxAccountFundInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "destinationAccountId": "acct_sandbox_example0001",
                    "amount": "1",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxAccountFundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "transferId": "trn_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "transferStatus": "posted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, funding_destination_role_forbidden, operation_environment_invalid.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "funding_destination_role_forbidden",
              "operation_environment_invalid"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sandbox/customer-access/{customerAccessId}/activate": {
      "post": {
        "operationId": "sandbox_customer_access_activate",
        "tags": [
          "customer_access"
        ],
        "summary": "Activate sandbox customer access",
        "description": "Activates a pending sandbox customer-access binding after the simulated provider flow has cleared the entity: person KYC or organization entity KYB. The operation consumes and seals that existing provenance; it never manufactures verified entity truth and does not require the live-only product activation review. Self-serve and confined to sandbox.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sandbox.customer_access.activate",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "customer:write"
        ],
        "x-hyperscale-environment": "sandbox",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sandbox.customer_access.activated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "customer_access",
              "action": "write",
              "tenantScoped": true,
              "idPath": "customerAccessId",
              "status": {
                "allowed": [
                  "pending",
                  "active"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "sandbox.customer_access.activated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Activate sandbox customer access",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Customers",
            "Access"
          ],
          "publicNoun": "Sandbox customer access activation",
          "resourceRef": "customer_access",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sandbox.customer_access.activated",
            "operation": "sandbox.customer_access.activate",
            "operationId": "sandbox_customer_access_activate",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SandboxCustomerAccessActivateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "customerAccessId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^cacc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale customer access ID"
            }
          },
          {
            "name": "X-Hyperscale-Environment",
            "in": "header",
            "description": "This operation is pinned to the sandbox environment; any other value is refused with `operation_environment_invalid`. Omitted requests already run in sandbox.",
            "required": false,
            "schema": {
              "type": "string",
              "const": "sandbox"
            }
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.sandboxCustomerAccessActivate({\n  path: {\n    customerAccessId: \"cacc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxCustomerAccessActivateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "customerAccessId": "cacc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "customerId": "cus_sandbox_example0001",
                      "entityId": "ent_sandbox_example0001",
                      "entityStatus": "pending",
                      "status": "pending",
                      "kycStatus": "not_required",
                      "amlStatus": "not_screened"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/sandbox/customer-onboarding": {
      "post": {
        "operationId": "sandbox_customer_onboard",
        "tags": [
          "customer"
        ],
        "summary": "Create a sandbox customer with cleared KYC",
        "description": "Creates a customer with its person entity and clears that entity's KYC against the simulated national identity provider, in one call a Product API key may make -- the two steps a key cannot otherwise reach, because KYC submission and verification are session-plane. The returned access binding is still pending; activate it, open the customer's account, and fund it with the sandbox operations the same key already calls. Sandbox only: refused outside sandbox, and the live path still requires the person's own session-plane submission. Starter apps call it when their seeded customer pool is empty.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "sandbox.customer.onboard",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "customer:write"
        ],
        "x-hyperscale-environment": "sandbox",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "external_confirmation"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "sandbox.customer.onboarded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "external"
          ]
        },
        "x-hyperscale-external-confirmation-capability": "kyc_verification_check",
        "x-hyperscale-external-confirmation-obligations": [
          {
            "kind": "kyc_verification_check",
            "required": true,
            "providerField": "provider",
            "providerReferenceField": "providerReference",
            "resourceIdPath": "profileId",
            "resourceKind": "entity_kyc_profile",
            "description": "The simulated eKYC verdict must enter as an External Confirmation carrying the verification provider reference that owns the identity fact, exactly as it does on the session-plane verification start.",
            "inBandClearance": true
          }
        ],
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "entity",
              "action": "create",
              "tenantScoped": false
            },
            {
              "kind": "customer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "customer_access",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "sandbox.customer.onboarded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy",
            "external confirmation obligation metadata"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources.",
            "Escalate missing, rejected, or conflicting External Confirmation."
          ],
          "externalProvider": true,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a sandbox customer with cleared KYC",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input.",
            "Refuse to claim external completion without matching External Confirmation."
          ],
          "receiptExpected": true,
          "risk": "external_provider",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Developer",
            "Sandbox"
          ],
          "publicNoun": "Sandbox customer onboarding",
          "resourceRef": "customer",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "identity"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "sandbox.customer.onboarded",
            "operation": "sandbox.customer.onboard",
            "operationId": "sandbox_customer_onboard",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SandboxCustomerOnboardOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "X-Hyperscale-Environment",
            "in": "header",
            "description": "This operation is pinned to the sandbox environment; any other value is refused with `operation_environment_invalid`. Omitted requests already run in sandbox.",
            "required": false,
            "schema": {
              "type": "string",
              "const": "sandbox"
            }
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.sandboxCustomerOnboard({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "external_confirmation_conflict",
          "external_confirmation_not_found",
          "external_confirmation_resource_conflict",
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "provider_outcome_unsupported",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SandboxCustomerOnboardInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SandboxCustomerOnboardOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "customerId": "cus_sandbox_example0001",
                      "customerAccessId": "cacc_sandbox_example0001",
                      "entityId": "ent_sandbox_example0001",
                      "entityStatus": "pending",
                      "profileId": "ekp_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, provider_outcome_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "provider_outcome_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, external_confirmation_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "external_confirmation_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, external_confirmation_conflict, external_confirmation_resource_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "external_confirmation_conflict",
              "external_confirmation_resource_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/savings-circles": {
      "post": {
        "operationId": "savings_circle_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Form a savings circle",
        "description": "Declares the seats, the periodic contribution, and the start moment, and provisions the shared pot escrow account members contribute into.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "savings_circle.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "savings_circle:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "savings_circle.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "savings_circle.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Form a savings circle",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Savings Circles"
          ],
          "publicNoun": "Savings circle",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "savings_circle"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "savings_circle.created",
            "operation": "savings_circle.create",
            "operationId": "savings_circle_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SavingsCircleCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.savingsCircleCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_jamiya00001\",\n    memberCount: 3,\n    contributionAmount: \"100000\",\n    currency: \"SAR\",\n    startAt: \"2026-08-01T21:00:00.000Z\",\n    memo: \"Al Harbi family circle, three seats.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SavingsCircleCreateInput"
              },
              "examples": {
                "form_family_circle": {
                  "value": {
                    "workspaceId": "wsp_sandbox_jamiya00001",
                    "memberCount": 3,
                    "contributionAmount": "100000",
                    "currency": "SAR",
                    "startAt": "2026-08-01T21:00:00.000Z",
                    "memo": "Al Harbi family circle, three seats."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_jamiya00001",
                    "memberCount": 3,
                    "contributionAmount": "100000",
                    "currency": "SAR",
                    "startAt": "2026-08-01T21:00:00.000Z",
                    "memo": "Al Harbi family circle, three seats."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavingsCircleCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "savingsCircleId": "jam_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "savings_circle",
                      "status": "forming",
                      "fields": {
                        "memberCount": 2,
                        "contributionAmount": "1",
                        "currency": "SAR",
                        "startAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "potAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, insufficient_balance, ledger_transfer_rejected, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "savings_circle_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List savings circles",
        "description": "List savings circles",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "savings_circle.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "savings_circle:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "savings_circle.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List savings circles",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Savings Circles"
          ],
          "publicNoun": "Savings circle",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "savings_circle"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "forming",
                "active",
                "completed",
                "disbanded"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "contributionAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "contributionAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "startAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.savingsCircleList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"forming\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    contributionAmountFrom: \"1\",\n    contributionAmountTo: \"1\",\n    currency: \"SAR\",\n    startAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavingsCircleListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/savings-circles/{savingsCircleId}": {
      "get": {
        "operationId": "savings_circle_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a savings circle",
        "description": "Retrieve a savings circle",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "savings_circle.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "savings_circle:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "savings_circle.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "savingsCircleId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a savings circle",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Savings Circles"
          ],
          "publicNoun": "Savings circle",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "savings_circle"
        ],
        "parameters": [
          {
            "name": "savingsCircleId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Savings circle instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.savingsCircleRetrieve({\n  path: {\n    savingsCircleId: \"jam_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavingsCircleRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "savingsCircleId": "jam_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "savings_circle",
                      "status": "forming",
                      "fields": {
                        "memberCount": 2,
                        "contributionAmount": "1",
                        "currency": "SAR",
                        "startAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "potAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/savings-circles/{savingsCircleId}/close": {
      "post": {
        "operationId": "savings_circle_close",
        "tags": [
          "noun_instance"
        ],
        "summary": "Close a completed circle",
        "description": "Closes the rotation once every membership is paid and the pot holds nothing, so a circle can never end while value is stranded in escrow.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "savings_circle.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "savings_circle:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "savings_circle.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "savingsCircleId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "savings_circle.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Close a completed circle",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Savings Circles"
          ],
          "publicNoun": "Savings circle",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "savings_circle"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "savings_circle.closed",
            "operation": "savings_circle.close",
            "operationId": "savings_circle_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SavingsCircleCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "savingsCircleId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Savings circle instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.savingsCircleClose({\n  path: {\n    savingsCircleId: \"jam_sandbox_alharbi0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "aggregate_condition_unmet",
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavingsCircleCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "savingsCircleId": "jam_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "savings_circle",
                      "status": "completed",
                      "fields": {
                        "memberCount": 2,
                        "contributionAmount": "1",
                        "currency": "SAR",
                        "startAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "potAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, aggregate_condition_unmet, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "aggregate_condition_unmet",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/savings-circles/{savingsCircleId}/disband": {
      "post": {
        "operationId": "savings_circle_disband",
        "tags": [
          "noun_instance"
        ],
        "summary": "Disband a forming circle",
        "description": "Cancels a circle that never filled. Members withdraw themselves under the machine principal once the circle is disbanded; no money has moved before activation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "savings_circle.disband",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "savings_circle:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "savings_circle.disbanded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "savingsCircleId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "savings_circle.disbanded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Disband a forming circle",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Savings Circles"
          ],
          "publicNoun": "Savings circle",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "savings_circle"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "savings_circle.disbanded",
            "operation": "savings_circle.disband",
            "operationId": "savings_circle_disband",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SavingsCircleDisbandOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "savingsCircleId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^jam_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Savings circle instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.savingsCircleDisband({\n  path: {\n    savingsCircleId: \"jam_sandbox_alharbi0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SavingsCircleDisbandOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "savingsCircleId": "jam_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "savings_circle",
                      "status": "disbanded",
                      "fields": {
                        "memberCount": 2,
                        "contributionAmount": "1",
                        "currency": "SAR",
                        "startAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "potAccountId": "acct_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/subject-kinds": {
      "get": {
        "operationId": "subject_kind_list",
        "tags": [
          "workspace"
        ],
        "summary": "List registered subject kinds",
        "description": "Lists every registered subject kind for the tenant — the sealed platform kinds (origin `platform`) and the tenant's own registered kinds (origin `tenant`) — with each kind's version, attribute JSON Schema, and the business nouns that accept it. This is the shape a subject.create call must satisfy before a subject-bearing noun can link it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "subject_kind.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "subject_kind.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List registered subject kinds",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.subjectKindList({\n  query: {\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubjectKindListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/subjects": {
      "post": {
        "operationId": "subject_create",
        "tags": [
          "subject"
        ],
        "summary": "Create a subject",
        "description": "Creates the thing a product trades, protects, rents, or finances from a registered subject kind and its versioned attributes.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "subject.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "workspace:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "subject.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 15
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "subject",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "subject.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a subject",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Products",
            "Subjects"
          ],
          "publicNoun": "Subject",
          "resourceRef": "subject",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "subject.created",
            "operation": "subject.create",
            "operationId": "subject_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/SubjectCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.subjectCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_marketplace001\",\n    kind: \"vehicle\",\n    kindVersion: 1,\n    attributes: {\n      vin: \"JTMAB3FV0KD123456\",\n      make: \"Toyota\",\n      model: \"Land Cruiser\",\n      year: \"2024\",\n      mileageKm: 12000,\n    },\n    declaredValue: {\n      amount: \"15000000\",\n      currency: \"SAR\",\n    },\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubjectCreateInput"
              },
              "examples": {
                "create_vehicle_subject": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace001",
                    "kind": "vehicle",
                    "kindVersion": 1,
                    "attributes": {
                      "vin": "JTMAB3FV0KD123456",
                      "make": "Toyota",
                      "model": "Land Cruiser",
                      "year": "2024",
                      "mileageKm": 12000
                    },
                    "declaredValue": {
                      "amount": "15000000",
                      "currency": "SAR"
                    }
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_marketplace001",
                    "kind": "vehicle",
                    "kindVersion": 1,
                    "attributes": {
                      "vin": "JTMAB3FV0KD123456",
                      "make": "Toyota",
                      "model": "Land Cruiser",
                      "year": "2024",
                      "mileageKm": 12000
                    },
                    "declaredValue": {
                      "amount": "15000000",
                      "currency": "SAR"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubjectCreateOutput"
                },
                "examples": {
                  "create_vehicle_subject": {
                    "value": {
                      "subjectId": "sbj_sandbox_landcruiser1",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "workspaceId": "wsp_sandbox_marketplace001",
                      "kind": "vehicle",
                      "kindVersion": 1,
                      "attributes": {
                        "vin": "JTMAB3FV0KD123456",
                        "make": "Toyota",
                        "model": "Land Cruiser",
                        "year": "2024",
                        "mileageKm": 12000
                      },
                      "declaredValue": {
                        "amount": "15000000",
                        "currency": "SAR"
                      },
                      "createdAt": "2026-07-20T09:29:00.000Z",
                      "metadata": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "subject_list",
        "tags": [
          "subject"
        ],
        "summary": "List Subjects",
        "description": "List Subjects as a cursor-paginated page. The thing a Product trades, protects, rents, or finances, with versioned attributes and one declared monetary value.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "subject.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "subject.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Subjects",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Products",
            "Subjects"
          ],
          "publicNoun": "Subject",
          "resourceRef": "subject",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.subjectList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubjectListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/subjects/{subjectId}": {
      "get": {
        "operationId": "subject_retrieve",
        "tags": [
          "subject"
        ],
        "summary": "Retrieve a Subject",
        "description": "Retrieve a single Subject by its subjectId. The thing a Product trades, protects, rents, or finances, with versioned attributes and one declared monetary value.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "subject.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "subject.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subjectId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Subject",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Products",
            "Subjects"
          ],
          "publicNoun": "Subject",
          "resourceRef": "subject",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "accounts"
        ],
        "parameters": [
          {
            "name": "subjectId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.subjectRetrieve({\n  path: {\n    subjectId: \"sbj_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubjectRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "subjectId": "sbj_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements": {
      "post": {
        "operationId": "trade_settlement_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a two-party trade settlement",
        "description": "Create a two-party trade settlement",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "trade_settlement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sideAAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sideBAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "platformAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "trade_settlement.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a two-party trade settlement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trade_settlement.created",
            "operation": "trade_settlement.create",
            "operationId": "trade_settlement_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TradeSettlementCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    sideAAccountId: \"acct_sandbox_example0001\",\n    sideBAccountId: \"acct_sandbox_example0001\",\n    platformAccountId: \"acct_sandbox_example0001\",\n    sideAAmount: \"1\",\n    sideBAmount: \"1\",\n    sideAServiceFeeAmount: \"1\",\n    sideBServiceFeeAmount: \"1\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TradeSettlementCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "sideAAccountId": "acct_sandbox_example0001",
                    "sideBAccountId": "acct_sandbox_example0001",
                    "platformAccountId": "acct_sandbox_example0001",
                    "sideAAmount": "1",
                    "sideBAmount": "1",
                    "sideAServiceFeeAmount": "1",
                    "sideBServiceFeeAmount": "1",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "created",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "trade_settlement_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List trade settlements",
        "description": "List trade settlements",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trade_settlement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List trade settlements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "funded",
                "released",
                "settled",
                "cancelled",
                "abandoned",
                "clawed_back"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "sideAAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "First trade party and funder",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "sideBAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Second trade party and funder",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "platformAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Workspace revenue or customer balance account collecting trade service fees",
              "x-hyperscale-fee-collection-port": true,
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance",
                  "workspace_revenue"
                ]
              }
            }
          },
          {
            "name": "sideAAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideAAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideBAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideBAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideAServiceFeeAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideAServiceFeeAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideBServiceFeeAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "sideBServiceFeeAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "clawbackAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    sideAAccountId: \"acct_sandbox_example0001\",\n    sideBAccountId: \"acct_sandbox_example0001\",\n    platformAccountId: \"acct_sandbox_example0001\",\n    sideAAmountFrom: \"1\",\n    sideAAmountTo: \"1\",\n    sideBAmountFrom: \"1\",\n    sideBAmountTo: \"1\",\n    sideAServiceFeeAmountFrom: \"1\",\n    sideAServiceFeeAmountTo: \"1\",\n    sideBServiceFeeAmountFrom: \"1\",\n    sideBServiceFeeAmountTo: \"1\",\n    clawbackAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements/{tradeSettlementId}": {
      "get": {
        "operationId": "trade_settlement_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a trade settlement",
        "description": "Retrieve a trade settlement",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trade_settlement:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "tradeSettlementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a trade settlement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "parameters": [
          {
            "name": "tradeSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Trade settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementRetrieve({\n  path: {\n    tradeSettlementId: \"trade_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "created",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements/{tradeSettlementId}/abandon": {
      "post": {
        "operationId": "trade_settlement_abandon",
        "tags": [
          "noun_instance"
        ],
        "summary": "Abandon the trade before its atomic funding batch",
        "description": "Abandon the trade before its atomic funding batch",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.abandon",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "trade_settlement:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.abandoned",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "tradeSettlementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "trade_settlement.abandoned"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Abandon the trade before its atomic funding batch",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trade_settlement.abandoned",
            "operation": "trade_settlement.abandon",
            "operationId": "trade_settlement_abandon",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TradeSettlementAbandonOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "tradeSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Trade settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementAbandon({\n  path: {\n    tradeSettlementId: \"trade_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementAbandonOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "abandoned",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements/{tradeSettlementId}/cancel": {
      "post": {
        "operationId": "trade_settlement_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel and refund both funded trade sides atomically",
        "description": "Cancel and refund both funded trade sides atomically",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "trade_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.cancelled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "tradeSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "trade_settlement.cancelled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel and refund both funded trade sides atomically",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trade_settlement.cancelled",
            "operation": "trade_settlement.cancel",
            "operationId": "trade_settlement_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TradeSettlementCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "tradeSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Trade settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementCancel({\n  path: {\n    tradeSettlementId: \"trade_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "cancelled",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements/{tradeSettlementId}/dispute": {
      "post": {
        "operationId": "trade_settlement_dispute",
        "tags": [
          "noun_instance"
        ],
        "summary": "Claw back the whole released trade before maturity",
        "description": "Voids both pending cross-payments first, then returns each principal to its original funder in the same linked ledger batch. Service fees remain posted because they paid for custody already provided.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.dispute",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "trade_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.clawed_back",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "tradeSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "write",
              "tenantScoped": true
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "trade_settlement.clawed_back"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Claw back the whole released trade before maturity",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trade_settlement.clawed_back",
            "operation": "trade_settlement.dispute",
            "operationId": "trade_settlement_dispute",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TradeSettlementDisputeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "tradeSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Trade settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementDispute({\n  path: {\n    tradeSettlementId: \"trade_sandbox_example0001\",\n  },\n  body: {\n    actorAccountId: \"acct_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "port_actor_not_allowed",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TradeSettlementDisputeBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "actorAccountId": "acct_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementDisputeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "clawed_back",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, port_actor_not_allowed, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "port_actor_not_allowed",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements/{tradeSettlementId}/fund": {
      "post": {
        "operationId": "trade_settlement_fund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund both trade sides and collect both custody fees atomically",
        "description": "Fund both trade sides and collect both custody fees atomically",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.fund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "trade_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "tradeSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "trade_settlement.funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund both trade sides and collect both custody fees atomically",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trade_settlement.funded",
            "operation": "trade_settlement.fund",
            "operationId": "trade_settlement_fund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TradeSettlementFundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "tradeSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Trade settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementFund({\n  path: {\n    tradeSettlementId: \"trade_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementFundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "funded",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trade-settlements/{tradeSettlementId}/release": {
      "post": {
        "operationId": "trade_settlement_release",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reserve both trade payouts for the clawback window",
        "description": "The tenant backend confirms the entire two-sided exchange. Both cross-payments become pending reservations in one linked batch; neither party can spend them before maturity.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trade_settlement.release",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "trade_settlement:write",
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trade_settlement.released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "tradeSettlementId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "trade_settlement.released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reserve both trade payouts for the clawback window",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Trade Settlements"
          ],
          "publicNoun": "Trade settlement",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "trade_settlement"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trade_settlement.released",
            "operation": "trade_settlement.release",
            "operationId": "trade_settlement_release",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TradeSettlementReleaseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "tradeSettlementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^trade_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Trade settlement instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.tradeSettlementRelease({\n  path: {\n    tradeSettlementId: \"trade_sandbox_example0001\",\n  },\n  body: {\n    actorAccountId: \"acct_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "port_actor_not_allowed",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_expiry_invalid",
          "transfer_expiry_past",
          "transfer_expiry_too_large",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TradeSettlementReleaseBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "actorAccountId": "acct_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TradeSettlementReleaseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tradeSettlementId": "trade_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "trade_settlement",
                      "status": "released",
                      "fields": {
                        "sideAAccountId": "acct_sandbox_example0001",
                        "sideBAccountId": "acct_sandbox_example0001",
                        "platformAccountId": "acct_sandbox_example0001",
                        "sideAAmount": "1",
                        "sideBAmount": "1",
                        "sideAServiceFeeAmount": "1",
                        "sideBServiceFeeAmount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "sideAFundingTransferId": "resource_sandbox_example0001",
                        "sideBFundingTransferId": "resource_sandbox_example0001",
                        "sideAServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideBServiceFeeTransferId": "resource_sandbox_example0001",
                        "sideAReleaseReservationId": "resource_sandbox_example0001",
                        "sideBReleaseReservationId": "resource_sandbox_example0001",
                        "sideAClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideBClawbackRefundTransferId": "ref_sandbox_example0001",
                        "sideACancelRefundTransferId": "ref_sandbox_example0001",
                        "sideBCancelRefundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_expiry_invalid, transfer_expiry_past, transfer_expiry_too_large, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_expiry_invalid",
              "transfer_expiry_past",
              "transfer_expiry_too_large",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, port_actor_not_allowed, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "port_actor_not_allowed",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/travel-packages": {
      "post": {
        "operationId": "travel_package_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Draft a travel package",
        "description": "Opens the bundled trip for one traveler party and names the payer the legs will settle against. No money moves and no account is provisioned: every transfer of the trip belongs to a linked flight booking or hotel stay.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "travel_package.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "travel_package:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "travel_package.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "payerAccountId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "travel_package.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Draft a travel package",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Travel Packages"
          ],
          "publicNoun": "Travel package",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "travel_package"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "travel_package.created",
            "operation": "travel_package.create",
            "operationId": "travel_package_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TravelPackageCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.travelPackageCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_travel000001\",\n    subject: \"sbj_sandbox_travelparty01\",\n    payerAccountId: \"acct_sandbox_traveler0001\",\n    departAt: \"2026-09-01T21:00:00.000Z\",\n    memo: \"Jeddah corniche long weekend.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TravelPackageCreateInput"
              },
              "examples": {
                "draft_jeddah_getaway": {
                  "value": {
                    "workspaceId": "wsp_sandbox_travel000001",
                    "subject": "sbj_sandbox_travelparty01",
                    "payerAccountId": "acct_sandbox_traveler0001",
                    "departAt": "2026-09-01T21:00:00.000Z",
                    "memo": "Jeddah corniche long weekend."
                  }
                },
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_travel000001",
                    "subject": "sbj_sandbox_travelparty01",
                    "payerAccountId": "acct_sandbox_traveler0001",
                    "departAt": "2026-09-01T21:00:00.000Z",
                    "memo": "Jeddah corniche long weekend."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TravelPackageCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "travelPackageId": "tpkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "travel_package",
                      "status": "draft",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "departAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "travel_package_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List travel packages",
        "description": "List travel packages",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "travel_package.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "travel_package:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "travel_package.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List travel packages",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Travel Packages"
          ],
          "publicNoun": "Travel package",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "travel_package"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "draft",
                "booked",
                "completed",
                "cancelled"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "payerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "departAt",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.travelPackageList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"draft\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    payerAccountId: \"acct_sandbox_example0001\",\n    departAt: \"2026-01-01T00:00:00.000Z\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TravelPackageListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/travel-packages/{travelPackageId}": {
      "get": {
        "operationId": "travel_package_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a travel package",
        "description": "Retrieve a travel package",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "travel_package.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "travel_package:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "travel_package.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "travelPackageId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a travel package",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Travel Packages"
          ],
          "publicNoun": "Travel package",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "travel_package"
        ],
        "parameters": [
          {
            "name": "travelPackageId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Travel package instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.travelPackageRetrieve({\n  path: {\n    travelPackageId: \"tpkg_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TravelPackageRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "travelPackageId": "tpkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "travel_package",
                      "status": "draft",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "departAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/travel-packages/{travelPackageId}/cancel": {
      "post": {
        "operationId": "travel_package_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Cancel a booked travel package",
        "description": "Cancels the bundled trip as one pure transition. The refunds are the legs' own: each confirmed flight booking and hotel stay referencing this package becomes due for its package_cancel verb under the parent-status gate and refunds its full reserve as its own receipted operation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "travel_package.cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "travel_package:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "travel_package.canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "travelPackageId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "travel_package.canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Cancel a booked travel package",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Travel Packages"
          ],
          "publicNoun": "Travel package",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "travel_package"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "travel_package.canceled",
            "operation": "travel_package.cancel",
            "operationId": "travel_package_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TravelPackageCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "travelPackageId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Travel package instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.travelPackageCancel({\n  path: {\n    travelPackageId: \"tpkg_sandbox_getaway00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TravelPackageCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "travelPackageId": "tpkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "travel_package",
                      "status": "cancelled",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "departAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/travel-packages/{travelPackageId}/complete": {
      "post": {
        "operationId": "travel_package_complete",
        "tags": [
          "noun_instance"
        ],
        "summary": "Complete a delivered travel package",
        "description": "Closes a booked package once the trip has run. Pure transition: the legs' own departure and checkout due verbs already paid their operators from their reserves.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "travel_package.complete",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "travel_package:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "travel_package.completed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "travelPackageId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "travel_package.completed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Complete a delivered travel package",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Travel Packages"
          ],
          "publicNoun": "Travel package",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "travel_package"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "travel_package.completed",
            "operation": "travel_package.complete",
            "operationId": "travel_package_complete",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TravelPackageCompleteOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "travelPackageId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Travel package instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.travelPackageComplete({\n  path: {\n    travelPackageId: \"tpkg_sandbox_getaway00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TravelPackageCompleteOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "travelPackageId": "tpkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "travel_package",
                      "status": "completed",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "departAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/travel-packages/{travelPackageId}/confirm": {
      "post": {
        "operationId": "travel_package_confirm",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm a travel package",
        "description": "Books the package once every linked leg has confirmed: refused (409 aggregate_condition_unmet) while any flight booking or hotel stay referencing this package is in any status but confirmed. Booking the package moves no money -- each leg's fare or rate already settled into that leg's own reserve at its own confirm.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "travel_package.confirm",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "travel_package:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "travel_package.confirmed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "travelPackageId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "travel_package.confirmed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm a travel package",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Travel Packages"
          ],
          "publicNoun": "Travel package",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "travel_package"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "travel_package.confirmed",
            "operation": "travel_package.confirm",
            "operationId": "travel_package_confirm",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TravelPackageConfirmOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "travelPackageId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^tpkg_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Travel package instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.travelPackageConfirm({\n  path: {\n    travelPackageId: \"tpkg_sandbox_getaway00001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "aggregate_condition_unmet",
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TravelPackageConfirmOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "travelPackageId": "tpkg_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "travel_package",
                      "status": "booked",
                      "fields": {
                        "payerAccountId": "acct_sandbox_example0001",
                        "departAt": "2026-01-01T00:00:00.000Z"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, aggregate_condition_unmet, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "aggregate_condition_unmet",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-requirements": {
      "get": {
        "operationId": "trust_requirement_list",
        "tags": [
          "trust_requirement"
        ],
        "summary": "List Trust Review requirements",
        "description": "List Trust Review requirements as a cursor-paginated page. One named thing a Trust Review still needs before it can be decided. The platform records requirements during review, and the company answers each by citing evidence.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_requirement.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trust_review:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust_requirement.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_requirement",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Trust Review requirements",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust Review requirement",
          "resourceRef": "trust_requirement",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "trustReviewId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale trust review ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "open",
                "satisfied",
                "waived",
                "rejected"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustRequirementList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    trustReviewId: \"vcs_sandbox_example0001\",\n    status: \"open\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustRequirementListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-requirements/{trustRequirementId}": {
      "get": {
        "operationId": "trust_requirement_retrieve",
        "tags": [
          "trust_requirement"
        ],
        "summary": "Retrieve a Trust Review requirement",
        "description": "Retrieve a single Trust Review requirement by its trustRequirementId. One named thing a Trust Review still needs before it can be decided. The platform records requirements during review, and the company answers each by citing evidence.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_requirement.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trust_review:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust_requirement.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_requirement",
              "action": "read",
              "tenantScoped": true,
              "idPath": "trustRequirementId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Trust Review requirement",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust Review requirement",
          "resourceRef": "trust_requirement",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "trustRequirementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustRequirementRetrieve({\n  path: {\n    trustRequirementId: \"vreq_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustRequirementRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "trustRequirementId": "vreq_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-requirements/{trustRequirementId}/respond": {
      "post": {
        "operationId": "trust_requirement_respond",
        "tags": [
          "trust_requirement"
        ],
        "summary": "Respond to a trust requirement",
        "description": "Submits a tenant response to an open trust requirement, citing previously attached evidence, free-text response, or both. At least one of evidence or response text is required; the requirement advances toward satisfied pending review.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_requirement.respond",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "trust_review:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust.review.requirement.responded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_requirement",
              "action": "write",
              "tenantScoped": true,
              "idPath": "trustRequirementId",
              "status": {
                "allowed": [
                  "open"
                ]
              }
            },
            {
              "kind": "trust_review",
              "action": "read",
              "tenantScoped": true,
              "idPath": "trustReviewId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "trust.review.requirement.responded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Respond to a trust requirement",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust review requirement response",
          "resourceRef": "trust_requirement",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trust.review.requirement.responded",
            "operation": "trust_requirement.respond",
            "operationId": "trust_requirement_respond",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TrustRequirementRespondOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "trustRequirementId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vreq_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale trust review requirement ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustRequirementRespond({\n  path: {\n    trustRequirementId: \"vreq_sandbox_bankletter01\",\n  },\n  body: {\n    trustReviewId: \"vcs_sandbox_livekyb001\",\n    trustEvidenceId: \"vev_sandbox_wathq0001\",\n    response: \"Bank letter uploaded for review.\",\n    metadata: {\n      channel: \"product\",\n    },\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "trust_evidence_case_mismatch",
          "trust_evidence_checksum_algorithm_unsupported",
          "trust_evidence_checksum_invalid",
          "trust_evidence_checksum_required",
          "trust_evidence_document_type_required",
          "trust_evidence_document_type_unsupported",
          "trust_evidence_duplicate_checksum",
          "trust_evidence_kind_unsupported",
          "trust_evidence_not_found",
          "trust_requirement_evidence_stale",
          "trust_requirement_not_found",
          "trust_requirement_proof_source_unsupported",
          "trust_requirement_provider_proof_required",
          "trust_requirement_status_forbidden",
          "trust_requirement_status_unsupported",
          "trust_review_business_identity_mismatch",
          "trust_review_business_profile_not_found",
          "trust_review_decision_reason_code_required",
          "trust_review_decision_reason_code_unsupported",
          "trust_review_not_approved",
          "trust_review_not_found",
          "trust_review_ownership_exceeds_total",
          "trust_review_registration_status_unsupported",
          "trust_review_risk_level_unsupported",
          "trust_review_risk_score_invalid",
          "trust_review_status_forbidden",
          "trust_review_subject_control_type_unsupported",
          "trust_review_subject_entity_required",
          "trust_review_subject_not_found",
          "trust_review_subject_ownership_percentage_invalid",
          "trust_review_subject_role_unsupported",
          "trust_review_subject_status_unsupported",
          "trust_review_target_tenant_mismatch",
          "trust_review_target_unsupported",
          "trust_review_workspace_mismatch"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrustRequirementRespondBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "trustReviewId": "vcs_sandbox_livekyb001",
                    "trustEvidenceId": "vev_sandbox_wathq0001",
                    "response": "Bank letter uploaded for review.",
                    "metadata": {
                      "channel": "product"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustRequirementRespondOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "trustRequirementId": "vreq_sandbox_bankletter01",
                      "trustReviewId": "vcs_sandbox_livekyb001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "status": "satisfied"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, trust_evidence_checksum_algorithm_unsupported, trust_evidence_checksum_invalid, trust_evidence_checksum_required, trust_evidence_document_type_required, trust_evidence_document_type_unsupported, trust_evidence_kind_unsupported, trust_requirement_proof_source_unsupported, trust_requirement_status_unsupported, trust_review_decision_reason_code_required, trust_review_decision_reason_code_unsupported, trust_review_registration_status_unsupported, trust_review_risk_level_unsupported, trust_review_risk_score_invalid, trust_review_subject_control_type_unsupported, trust_review_subject_entity_required, trust_review_subject_ownership_percentage_invalid, trust_review_subject_role_unsupported, trust_review_subject_status_unsupported, trust_review_target_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "trust_evidence_checksum_algorithm_unsupported",
              "trust_evidence_checksum_invalid",
              "trust_evidence_checksum_required",
              "trust_evidence_document_type_required",
              "trust_evidence_document_type_unsupported",
              "trust_evidence_kind_unsupported",
              "trust_requirement_proof_source_unsupported",
              "trust_requirement_status_unsupported",
              "trust_review_decision_reason_code_required",
              "trust_review_decision_reason_code_unsupported",
              "trust_review_registration_status_unsupported",
              "trust_review_risk_level_unsupported",
              "trust_review_risk_score_invalid",
              "trust_review_subject_control_type_unsupported",
              "trust_review_subject_entity_required",
              "trust_review_subject_ownership_percentage_invalid",
              "trust_review_subject_role_unsupported",
              "trust_review_subject_status_unsupported",
              "trust_review_target_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, trust_review_target_tenant_mismatch.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "trust_review_target_tenant_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, trust_evidence_not_found, trust_requirement_not_found, trust_review_business_profile_not_found, trust_review_not_found, trust_review_subject_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "trust_evidence_not_found",
              "trust_requirement_not_found",
              "trust_review_business_profile_not_found",
              "trust_review_not_found",
              "trust_review_subject_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, trust_evidence_case_mismatch, trust_evidence_duplicate_checksum, trust_requirement_evidence_stale, trust_requirement_provider_proof_required, trust_requirement_status_forbidden, trust_review_business_identity_mismatch, trust_review_not_approved, trust_review_ownership_exceeds_total, trust_review_status_forbidden, trust_review_workspace_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "trust_evidence_case_mismatch",
              "trust_evidence_duplicate_checksum",
              "trust_requirement_evidence_stale",
              "trust_requirement_provider_proof_required",
              "trust_requirement_status_forbidden",
              "trust_review_business_identity_mismatch",
              "trust_review_not_approved",
              "trust_review_ownership_exceeds_total",
              "trust_review_status_forbidden",
              "trust_review_workspace_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-review-evidence": {
      "get": {
        "operationId": "trust_evidence_list",
        "tags": [
          "trust_evidence"
        ],
        "summary": "List Trust Review evidence",
        "description": "List Trust Review evidence as a cursor-paginated page. A document attached to a Trust Review, with its type, checksum, and size. Evidence lands pending review and satisfies nothing on its own; requirement responses cite it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_evidence.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trust_review:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust_evidence.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_evidence",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Trust Review evidence",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust Review evidence",
          "resourceRef": "trust_evidence",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "trustReviewId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale trust review ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustEvidenceList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    trustReviewId: \"vcs_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustEvidenceListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-review-evidence/{trustEvidenceId}": {
      "get": {
        "operationId": "trust_evidence_retrieve",
        "tags": [
          "trust_evidence"
        ],
        "summary": "Retrieve Trust Review evidence",
        "description": "Retrieve Trust Review evidence by its trustEvidenceId. A document attached to a Trust Review, with its type, checksum, and size. Evidence lands pending review and satisfies nothing on its own; requirement responses cite it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_evidence.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trust_review:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust_evidence.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_evidence",
              "action": "read",
              "tenantScoped": true,
              "idPath": "trustEvidenceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve Trust Review evidence",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust Review evidence",
          "resourceRef": "trust_evidence",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "trustEvidenceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustEvidenceRetrieve({\n  path: {\n    trustEvidenceId: \"vev_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustEvidenceRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "trustEvidenceId": "vev_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "resource_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-reviews": {
      "get": {
        "operationId": "trust_review_list",
        "tags": [
          "trust_review"
        ],
        "summary": "List Trust reviews",
        "description": "List Trust reviews as a cursor-paginated page. A risky action held for a decision: it pauses as a review and executes only once an approval is recorded. Going live is the review every company meets first.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_review.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trust_review:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust_review.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_review",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Trust reviews",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust review",
          "resourceRef": "trust_review",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "product_activation",
                "entity_kyb"
              ]
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "draft",
                "submitted",
                "under_review",
                "approved",
                "rejected",
                "cancelled"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustReviewList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    type: \"product_activation\",\n    status: \"draft\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustReviewListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-reviews/{trustReviewId}": {
      "get": {
        "operationId": "trust_review_retrieve",
        "tags": [
          "trust_review"
        ],
        "summary": "Retrieve a Trust review",
        "description": "Retrieve a single Trust review by its trustReviewId. A risky action held for a decision: it pauses as a review and executes only once an approval is recorded. Going live is the review every company meets first.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_review.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "trust_review:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust_review.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_review",
              "action": "read",
              "tenantScoped": true,
              "idPath": "trustReviewId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Trust review",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust review",
          "resourceRef": "trust_review",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "parameters": [
          {
            "name": "trustReviewId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustReviewRetrieve({\n  path: {\n    trustReviewId: \"vcs_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustReviewRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "trustReviewId": "vcs_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-reviews/{trustReviewId}/evidence": {
      "post": {
        "operationId": "trust_evidence_attach",
        "tags": [
          "trust_evidence"
        ],
        "summary": "Attach trust evidence",
        "description": "Attaches tenant-supplied evidence to a trust review, either an uploaded document or a requirement response, optionally bound to a specific subject or requirement. The attached evidence enters pending review and does not by itself satisfy a requirement.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_evidence.attach",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "trust_review:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust.review.evidence.attached",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_evidence",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "trust_review",
              "action": "read",
              "tenantScoped": true,
              "idPath": "trustReviewId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "trust.review.evidence.attached"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Attach trust evidence",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust review evidence",
          "resourceRef": "trust_evidence",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trust.review.evidence.attached",
            "operation": "trust_evidence.attach",
            "operationId": "trust_evidence_attach",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TrustEvidenceAttachOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "trustReviewId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale trust review ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustEvidenceAttach({\n  path: {\n    trustReviewId: \"vcs_sandbox_livekyb001\",\n  },\n  body: {\n    kind: \"document_upload\",\n    documentReference: \"doc_sandbox_bankletter01\",\n    documentType: \"bank_letter\",\n    checksum: \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n    checksumAlgorithm: \"sha256\",\n    filename: \"bank-letter.pdf\",\n    mimeType: \"application/pdf\",\n    byteSize: 48219,\n    metadata: {\n      uploadedBy: \"ops\",\n    },\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "trust_evidence_case_mismatch",
          "trust_evidence_checksum_algorithm_unsupported",
          "trust_evidence_checksum_invalid",
          "trust_evidence_checksum_required",
          "trust_evidence_document_type_required",
          "trust_evidence_document_type_unsupported",
          "trust_evidence_duplicate_checksum",
          "trust_evidence_kind_unsupported",
          "trust_evidence_not_found",
          "trust_requirement_evidence_stale",
          "trust_requirement_not_found",
          "trust_requirement_proof_source_unsupported",
          "trust_requirement_provider_proof_required",
          "trust_requirement_status_forbidden",
          "trust_requirement_status_unsupported",
          "trust_review_business_identity_mismatch",
          "trust_review_business_profile_not_found",
          "trust_review_decision_reason_code_required",
          "trust_review_decision_reason_code_unsupported",
          "trust_review_not_approved",
          "trust_review_not_found",
          "trust_review_ownership_exceeds_total",
          "trust_review_registration_status_unsupported",
          "trust_review_risk_level_unsupported",
          "trust_review_risk_score_invalid",
          "trust_review_status_forbidden",
          "trust_review_subject_control_type_unsupported",
          "trust_review_subject_entity_required",
          "trust_review_subject_not_found",
          "trust_review_subject_ownership_percentage_invalid",
          "trust_review_subject_role_unsupported",
          "trust_review_subject_status_unsupported",
          "trust_review_target_tenant_mismatch",
          "trust_review_target_unsupported",
          "trust_review_workspace_mismatch"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrustEvidenceAttachBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "kind": "document_upload",
                    "documentReference": "doc_sandbox_bankletter01",
                    "documentType": "bank_letter",
                    "checksum": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                    "checksumAlgorithm": "sha256",
                    "filename": "bank-letter.pdf",
                    "mimeType": "application/pdf",
                    "byteSize": 48219,
                    "metadata": {
                      "uploadedBy": "ops"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustEvidenceAttachOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "trustEvidenceId": "vev_sandbox_wathq0001",
                      "trustReviewId": "vcs_sandbox_livekyb001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "kind": "document_upload",
                      "documentType": "bank_letter",
                      "checksum": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                      "checksumAlgorithm": "sha256"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, trust_evidence_checksum_algorithm_unsupported, trust_evidence_checksum_invalid, trust_evidence_checksum_required, trust_evidence_document_type_required, trust_evidence_document_type_unsupported, trust_evidence_kind_unsupported, trust_requirement_proof_source_unsupported, trust_requirement_status_unsupported, trust_review_decision_reason_code_required, trust_review_decision_reason_code_unsupported, trust_review_registration_status_unsupported, trust_review_risk_level_unsupported, trust_review_risk_score_invalid, trust_review_subject_control_type_unsupported, trust_review_subject_entity_required, trust_review_subject_ownership_percentage_invalid, trust_review_subject_role_unsupported, trust_review_subject_status_unsupported, trust_review_target_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "trust_evidence_checksum_algorithm_unsupported",
              "trust_evidence_checksum_invalid",
              "trust_evidence_checksum_required",
              "trust_evidence_document_type_required",
              "trust_evidence_document_type_unsupported",
              "trust_evidence_kind_unsupported",
              "trust_requirement_proof_source_unsupported",
              "trust_requirement_status_unsupported",
              "trust_review_decision_reason_code_required",
              "trust_review_decision_reason_code_unsupported",
              "trust_review_registration_status_unsupported",
              "trust_review_risk_level_unsupported",
              "trust_review_risk_score_invalid",
              "trust_review_subject_control_type_unsupported",
              "trust_review_subject_entity_required",
              "trust_review_subject_ownership_percentage_invalid",
              "trust_review_subject_role_unsupported",
              "trust_review_subject_status_unsupported",
              "trust_review_target_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, trust_review_target_tenant_mismatch.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "trust_review_target_tenant_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, trust_evidence_not_found, trust_requirement_not_found, trust_review_business_profile_not_found, trust_review_not_found, trust_review_subject_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "trust_evidence_not_found",
              "trust_requirement_not_found",
              "trust_review_business_profile_not_found",
              "trust_review_not_found",
              "trust_review_subject_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, trust_evidence_case_mismatch, trust_evidence_duplicate_checksum, trust_requirement_evidence_stale, trust_requirement_provider_proof_required, trust_requirement_status_forbidden, trust_review_business_identity_mismatch, trust_review_not_approved, trust_review_ownership_exceeds_total, trust_review_status_forbidden, trust_review_workspace_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "trust_evidence_case_mismatch",
              "trust_evidence_duplicate_checksum",
              "trust_requirement_evidence_stale",
              "trust_requirement_provider_proof_required",
              "trust_requirement_status_forbidden",
              "trust_review_business_identity_mismatch",
              "trust_review_not_approved",
              "trust_review_ownership_exceeds_total",
              "trust_review_status_forbidden",
              "trust_review_workspace_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/trust-reviews/{trustReviewId}/submit": {
      "post": {
        "operationId": "trust_review_submit",
        "tags": [
          "trust_review"
        ],
        "summary": "Submit a trust review",
        "description": "Moves a draft trust review to submitted, handing it to admin and provider review; the tenant can no longer edit the review after submission. Requirements and evidence should be in place before submitting.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "trust_review.submit",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "trust_review:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "trust.review.submitted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "trust_review",
              "action": "write",
              "tenantScoped": true,
              "idPath": "trustReviewId",
              "status": {
                "allowed": [
                  "draft"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "trust.review.submitted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Submit a trust review",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Live",
            "Trust Reviews"
          ],
          "publicNoun": "Trust review submission",
          "resourceRef": "trust_review",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "verification"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "trust.review.submitted",
            "operation": "trust_review.submit",
            "operationId": "trust_review_submit",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/TrustReviewSubmitOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "trustReviewId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vcs_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale trust review ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.trustReviewSubmit({\n  path: {\n    trustReviewId: \"vcs_sandbox_livekyb001\",\n  },\n  body: {\n    submittedAt: \"2026-05-22T09:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "trust_evidence_case_mismatch",
          "trust_evidence_checksum_algorithm_unsupported",
          "trust_evidence_checksum_invalid",
          "trust_evidence_checksum_required",
          "trust_evidence_document_type_required",
          "trust_evidence_document_type_unsupported",
          "trust_evidence_duplicate_checksum",
          "trust_evidence_kind_unsupported",
          "trust_evidence_not_found",
          "trust_requirement_evidence_stale",
          "trust_requirement_not_found",
          "trust_requirement_proof_source_unsupported",
          "trust_requirement_provider_proof_required",
          "trust_requirement_status_forbidden",
          "trust_requirement_status_unsupported",
          "trust_review_business_identity_mismatch",
          "trust_review_business_profile_not_found",
          "trust_review_decision_reason_code_required",
          "trust_review_decision_reason_code_unsupported",
          "trust_review_not_approved",
          "trust_review_not_found",
          "trust_review_ownership_exceeds_total",
          "trust_review_registration_status_unsupported",
          "trust_review_risk_level_unsupported",
          "trust_review_risk_score_invalid",
          "trust_review_status_forbidden",
          "trust_review_subject_control_type_unsupported",
          "trust_review_subject_entity_required",
          "trust_review_subject_not_found",
          "trust_review_subject_ownership_percentage_invalid",
          "trust_review_subject_role_unsupported",
          "trust_review_subject_status_unsupported",
          "trust_review_target_tenant_mismatch",
          "trust_review_target_unsupported",
          "trust_review_workspace_mismatch"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrustReviewSubmitBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "submittedAt": "2026-05-22T09:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustReviewSubmitOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "trustReviewId": "vcs_sandbox_livekyb001",
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "status": "submitted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, trust_evidence_checksum_algorithm_unsupported, trust_evidence_checksum_invalid, trust_evidence_checksum_required, trust_evidence_document_type_required, trust_evidence_document_type_unsupported, trust_evidence_kind_unsupported, trust_requirement_proof_source_unsupported, trust_requirement_status_unsupported, trust_review_decision_reason_code_required, trust_review_decision_reason_code_unsupported, trust_review_registration_status_unsupported, trust_review_risk_level_unsupported, trust_review_risk_score_invalid, trust_review_subject_control_type_unsupported, trust_review_subject_entity_required, trust_review_subject_ownership_percentage_invalid, trust_review_subject_role_unsupported, trust_review_subject_status_unsupported, trust_review_target_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "trust_evidence_checksum_algorithm_unsupported",
              "trust_evidence_checksum_invalid",
              "trust_evidence_checksum_required",
              "trust_evidence_document_type_required",
              "trust_evidence_document_type_unsupported",
              "trust_evidence_kind_unsupported",
              "trust_requirement_proof_source_unsupported",
              "trust_requirement_status_unsupported",
              "trust_review_decision_reason_code_required",
              "trust_review_decision_reason_code_unsupported",
              "trust_review_registration_status_unsupported",
              "trust_review_risk_level_unsupported",
              "trust_review_risk_score_invalid",
              "trust_review_subject_control_type_unsupported",
              "trust_review_subject_entity_required",
              "trust_review_subject_ownership_percentage_invalid",
              "trust_review_subject_role_unsupported",
              "trust_review_subject_status_unsupported",
              "trust_review_target_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, trust_review_target_tenant_mismatch.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "trust_review_target_tenant_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, trust_evidence_not_found, trust_requirement_not_found, trust_review_business_profile_not_found, trust_review_not_found, trust_review_subject_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "trust_evidence_not_found",
              "trust_requirement_not_found",
              "trust_review_business_profile_not_found",
              "trust_review_not_found",
              "trust_review_subject_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, trust_evidence_case_mismatch, trust_evidence_duplicate_checksum, trust_requirement_evidence_stale, trust_requirement_provider_proof_required, trust_requirement_status_forbidden, trust_review_business_identity_mismatch, trust_review_not_approved, trust_review_ownership_exceeds_total, trust_review_status_forbidden, trust_review_workspace_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "trust_evidence_case_mismatch",
              "trust_evidence_duplicate_checksum",
              "trust_requirement_evidence_stale",
              "trust_requirement_provider_proof_required",
              "trust_requirement_status_forbidden",
              "trust_review_business_identity_mismatch",
              "trust_review_not_approved",
              "trust_review_ownership_exceeds_total",
              "trust_review_status_forbidden",
              "trust_review_workspace_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/usage-records": {
      "get": {
        "operationId": "usage_record_list",
        "tags": [
          "usage_record"
        ],
        "summary": "List Usage records",
        "description": "List Usage records as a cursor-paginated page. One metered event: the meter, the quantity, and the operation that produced it. Usage records roll up into the period snapshot that gets priced.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "usage_record.list",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "usage_record.list",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "usage",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List Usage records",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Usage"
          ],
          "publicNoun": "Usage record",
          "resourceRef": "usage_record",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "usage"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.usageRecordList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageRecordListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/usage-records/{usageRecordId}": {
      "get": {
        "operationId": "usage_record_retrieve",
        "tags": [
          "usage_record"
        ],
        "summary": "Retrieve a Usage record",
        "description": "Retrieve a single Usage record by its usageRecordId. One metered event: the meter, the quantity, and the operation that produced it. Usage records roll up into the period snapshot that gets priced.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "usage_record.retrieve",
        "x-hyperscale-audiences": [
          "tenant_portal",
          "tenant_sdk"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "usage:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "usage_record.retrieve",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "usage",
              "action": "read",
              "tenantScoped": true,
              "idPath": "usageRecordId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a Usage record",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Billing",
            "Usage"
          ],
          "publicNoun": "Usage record",
          "resourceRef": "usage_record",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "usage"
        ],
        "parameters": [
          {
            "name": "usageRecordId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.usageRecordRetrieve({\n  path: {\n    usageRecordId: \"usg_sandbox_example0001\",\n  },\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageRecordRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "usageRecordId": "usg_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "meter": "account.create"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows": {
      "post": {
        "operationId": "vehicle_escrow_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a vehicle escrow",
        "description": "Opens the escrow and provisions its dedicated product escrow account. The price is admitted against the motor policy's coverage cap.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "buyerAccountId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sellerAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "policyId"
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_escrow.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a vehicle escrow",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.created",
            "operation": "vehicle_escrow.create",
            "operationId": "vehicle_escrow_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    buyerAccountId: \"acct_sandbox_example0001\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    policyId: \"mpol_sandbox_example0001\",\n    price: \"1\",\n    currency: \"SAR\",\n    subject: \"sbj_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VehicleEscrowCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "buyerAccountId": "acct_sandbox_example0001",
                    "sellerAccountId": "acct_sandbox_example0001",
                    "policyId": "mpol_sandbox_example0001",
                    "price": "1",
                    "currency": "SAR",
                    "subject": "sbj_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "vehicle_escrow_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List vehicle escrows",
        "description": "List vehicle escrows",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "vehicle_escrow:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List vehicle escrows",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "funded",
                "settled",
                "cancel_quoted",
                "canceled",
                "penalty_collected"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "buyerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "sellerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "policyId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^mpol_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Motor policy that must be active for the escrow to clear"
            }
          },
          {
            "name": "priceFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "priceTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    buyerAccountId: \"acct_sandbox_example0001\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    policyId: \"mpol_sandbox_example0001\",\n    priceFrom: \"1\",\n    priceTo: \"1\",\n    currency: \"SAR\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows/{vehicleEscrowId}": {
      "get": {
        "operationId": "vehicle_escrow_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a vehicle escrow",
        "description": "Retrieve a vehicle escrow",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "vehicle_escrow:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a vehicle escrow",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowRetrieve({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "vehicle_escrow_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a vehicle escrow",
        "description": "Edits the mutable fields of a vehicle escrow (memo) while it is created. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "vehicle_escrow.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a vehicle escrow",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.updated",
            "operation": "vehicle_escrow.update",
            "operationId": "vehicle_escrow_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowUpdate({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VehicleEscrowUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "created",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows/{vehicleEscrowId}/collect-penalty": {
      "post": {
        "operationId": "vehicle_escrow_collect_penalty",
        "tags": [
          "noun_instance"
        ],
        "summary": "Collect a vehicle cancellation penalty",
        "description": "Pays the computed retained cancellation penalty to the seller. Invoke only when confirm_cancel returns a positive refs.unwindPenalty.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.collect_penalty",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.penalty_collected",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "vehicle_escrow.penalty_collected"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Collect a vehicle cancellation penalty",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.penalty_collected",
            "operation": "vehicle_escrow.collect_penalty",
            "operationId": "vehicle_escrow_collect_penalty",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowCollectPenaltyOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowCollectPenalty({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowCollectPenaltyOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "penalty_collected",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows/{vehicleEscrowId}/confirm-cancel": {
      "post": {
        "operationId": "vehicle_escrow_confirm_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Confirm a vehicle escrow cancellation",
        "description": "Unwinds the escrow, refunding the price minus the scheduled penalty to the buyer. The quote seeded that amount into refs.unwindRefund; this step moves it from the escrow account back to the buyer.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.confirm_cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.confirm_canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "vehicle_escrow.confirm_canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Confirm a vehicle escrow cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.confirm_canceled",
            "operation": "vehicle_escrow.confirm_cancel",
            "operationId": "vehicle_escrow_confirm_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowConfirmCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowConfirmCancel({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowConfirmCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "canceled",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows/{vehicleEscrowId}/fund": {
      "post": {
        "operationId": "vehicle_escrow_fund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Fund a vehicle escrow",
        "description": "Moves the price from the buyer account into the escrow account.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.fund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.funded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "vehicle_escrow.funded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Fund a vehicle escrow",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.funded",
            "operation": "vehicle_escrow.fund",
            "operationId": "vehicle_escrow_fund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowFundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowFund({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowFundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "funded",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows/{vehicleEscrowId}/quote-cancel": {
      "post": {
        "operationId": "vehicle_escrow_quote_cancel",
        "tags": [
          "noun_instance"
        ],
        "summary": "Quote a vehicle escrow cancellation",
        "description": "Parks the funded escrow for cancellation and quotes the refund under the penalty schedule. No money moves; the confirm executes the refund.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.quote_cancel",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.quote_canceled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_escrow.quote_canceled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Quote a vehicle escrow cancellation",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.quote_canceled",
            "operation": "vehicle_escrow.quote_cancel",
            "operationId": "vehicle_escrow_quote_cancel",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowQuoteCancelOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowQuoteCancel({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowQuoteCancelOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "cancel_quoted",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-escrows/{vehicleEscrowId}/release": {
      "post": {
        "operationId": "vehicle_escrow_release",
        "tags": [
          "noun_instance"
        ],
        "summary": "Release a vehicle escrow",
        "description": "Clears the full price from the escrow account to the seller while the car's motor policy is active.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_escrow.release",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "vehicle_escrow:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_escrow.released",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleEscrowId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "commercial": {
            "earnable": true
          },
          "audit": {
            "event": "vehicle_escrow.released"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Release a vehicle escrow",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Escrows"
          ],
          "publicNoun": "Vehicle escrow",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_escrow"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_escrow.released",
            "operation": "vehicle_escrow.release",
            "operationId": "vehicle_escrow_release",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleEscrowReleaseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleEscrowId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleEscrowRelease({\n  path: {\n    vehicleEscrowId: \"vesc_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleEscrowReleaseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleEscrowId": "vesc_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_escrow",
                      "status": "settled",
                      "fields": {
                        "buyerAccountId": "acct_sandbox_example0001",
                        "sellerAccountId": "acct_sandbox_example0001",
                        "policyId": "mpol_sandbox_example0001",
                        "price": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "escrowAccountId": "acct_sandbox_example0001",
                        "fundTransferId": "resource_sandbox_example0001",
                        "releaseTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001",
                        "penaltyTransferId": "resource_sandbox_example0001",
                        "unwindRefund": "240000",
                        "unwindPenalty": "0",
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-listings": {
      "post": {
        "operationId": "vehicle_listing_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a vehicle listing",
        "description": "Publishes the car to the marketplace at an asking price. No money moves until an escrow is opened against it.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "sellerAccountId"
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "escrowId",
              "optional": true
            },
            {
              "kind": "subject",
              "action": "read",
              "tenantScoped": true,
              "idPath": "subject"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_listing.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a vehicle listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_listing.created",
            "operation": "vehicle_listing.create",
            "operationId": "vehicle_listing_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleListingCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    headline: \"2022 Land Cruiser GXR, single owner\",\n    askingPrice: \"1\",\n    currency: \"SAR\",\n    subject: \"sbj_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_reference_not_found",
          "noun_retired",
          "noun_subject_kind_forbidden",
          "noun_subject_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VehicleListingCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "sellerAccountId": "acct_sandbox_example0001",
                    "headline": "2022 Land Cruiser GXR, single owner",
                    "askingPrice": "1",
                    "currency": "SAR",
                    "subject": "sbj_sandbox_example0001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "listed",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_retired, noun_subject_kind_forbidden, noun_subject_not_found, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_retired",
              "noun_subject_kind_forbidden",
              "noun_subject_not_found",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "vehicle_listing_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List vehicle listings",
        "description": "List vehicle listings",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "vehicle_listing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List vehicle listings",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "listed",
                "reserved",
                "sold",
                "delisted"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "sellerAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "askingPriceFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "askingPriceTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "escrowId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vesc_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle escrow whose held funds reserve this listing"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"listed\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    sellerAccountId: \"acct_sandbox_example0001\",\n    askingPriceFrom: \"1\",\n    askingPriceTo: \"1\",\n    currency: \"SAR\",\n    escrowId: \"vesc_sandbox_example0001\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-listings/{vehicleListingId}": {
      "get": {
        "operationId": "vehicle_listing_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a vehicle listing",
        "description": "Retrieve a vehicle listing",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "vehicle_listing:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "vehicleListingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a vehicle listing",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "parameters": [
          {
            "name": "vehicleListingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingRetrieve({\n  path: {\n    vehicleListingId: \"vlst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "listed",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "vehicle_listing_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a vehicle listing",
        "description": "Edits the mutable fields of a vehicle listing (headline, description, askingPrice, escrowId) while it is listed. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleListingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "vehicle_listing.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a vehicle listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_listing.updated",
            "operation": "vehicle_listing.update",
            "operationId": "vehicle_listing_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleListingUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleListingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingUpdate({\n  path: {\n    vehicleListingId: \"vlst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VehicleListingUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "listed",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-listings/{vehicleListingId}/complete": {
      "post": {
        "operationId": "vehicle_listing_complete",
        "tags": [
          "noun_instance"
        ],
        "summary": "Complete a vehicle listing sale",
        "description": "Marks the car sold after the reserving escrow settles to the seller. Pure lifecycle transition over the catalog row.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.complete",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.completed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleListingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_listing.completed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Complete a vehicle listing sale",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_listing.completed",
            "operation": "vehicle_listing.complete",
            "operationId": "vehicle_listing_complete",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleListingCompleteOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleListingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingComplete({\n  path: {\n    vehicleListingId: \"vlst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingCompleteOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "sold",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-listings/{vehicleListingId}/delist": {
      "post": {
        "operationId": "vehicle_listing_delist",
        "tags": [
          "noun_instance"
        ],
        "summary": "Delist a vehicle listing",
        "description": "Withdraws an unsold car from the marketplace. No money has moved, so this is a pure lifecycle transition.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.delist",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.delisted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleListingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_listing.delisted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Delist a vehicle listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_listing.delisted",
            "operation": "vehicle_listing.delist",
            "operationId": "vehicle_listing_delist",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleListingDelistOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleListingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingDelist({\n  path: {\n    vehicleListingId: \"vlst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingDelistOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "delisted",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-listings/{vehicleListingId}/reserve": {
      "post": {
        "operationId": "vehicle_listing_reserve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Reserve a vehicle listing",
        "description": "Takes the listing off the market while a buyer's escrow holds funds. The referenced escrow must currently hold the buyer's funds.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.reserve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.reserved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleListingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_listing.reserved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Reserve a vehicle listing",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_listing.reserved",
            "operation": "vehicle_listing.reserve",
            "operationId": "vehicle_listing_reserve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleListingReserveOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleListingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingReserve({\n  path: {\n    vehicleListingId: \"vlst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingReserveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "reserved",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/vehicle-listings/{vehicleListingId}/unreserve": {
      "post": {
        "operationId": "vehicle_listing_unreserve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Return a reserved vehicle listing to the market",
        "description": "Relists the car after the reserving escrow is canceled. No money has moved on the listing itself.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "vehicle_listing.unreserve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "vehicle_listing:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "vehicle_listing.unreserved",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "vehicleListingId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "vehicle_listing.unreserved"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Return a reserved vehicle listing to the market",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Vehicle Listings"
          ],
          "publicNoun": "Vehicle listing",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "vehicle_listing"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "vehicle_listing.unreserved",
            "operation": "vehicle_listing.unreserve",
            "operationId": "vehicle_listing_unreserve",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/VehicleListingUnreserveOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "vehicleListingId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^vlst_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Vehicle listing instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.vehicleListingUnreserve({\n  path: {\n    vehicleListingId: \"vlst_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListingUnreserveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "vehicleListingId": "vlst_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "vehicle_listing",
                      "status": "listed",
                      "fields": {
                        "sellerAccountId": "acct_sandbox_example0001",
                        "headline": "2022 Land Cruiser GXR, single owner",
                        "askingPrice": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "subject": "sbj_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallet-spends": {
      "post": {
        "operationId": "wallet_spend_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a wallet spend",
        "description": "Records the spend against an active wallet and admits its amount against the wallet's cumulative limit. The debited account and currency are derived from the wallet itself -- never caller-supplied. No money moves until the spend posts.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet_spend.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "wallet_spend:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet_spend.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "walletId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "beneficiaryAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "wallet_spend.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a wallet spend",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallet Spends"
          ],
          "publicNoun": "Wallet spend",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet_spend"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet_spend.created",
            "operation": "wallet_spend.create",
            "operationId": "wallet_spend_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletSpendCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletSpendCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    walletId: \"wal_sandbox_example0001\",\n    beneficiaryAccountId: \"acct_sandbox_example0001\",\n    amount: \"1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "mfa_verification_required",
          "noun_aggregate_cap_exceeded",
          "noun_aggregate_currency_mismatch",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WalletSpendCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "walletId": "wal_sandbox_example0001",
                    "beneficiaryAccountId": "acct_sandbox_example0001",
                    "amount": "1"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletSpendCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletSpendId": "wspd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet_spend",
                      "status": "created",
                      "fields": {
                        "walletId": "wal_sandbox_example0001",
                        "walletAccountId": "acct_sandbox_example0001",
                        "beneficiaryAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "spendTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_reference_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_reference_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, customer_access_compliance_forbidden, noun_aggregate_cap_exceeded, noun_aggregate_currency_mismatch, noun_reference_required, noun_reference_status_forbidden, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "customer_access_compliance_forbidden",
              "noun_aggregate_cap_exceeded",
              "noun_aggregate_currency_mismatch",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "wallet_spend_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List wallet spends",
        "description": "List wallet spends",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet_spend.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "wallet_spend:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet_spend.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List wallet spends",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallet Spends"
          ],
          "publicNoun": "Wallet spend",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet_spend"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "posted",
                "refunded"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "walletId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet this spend draws from"
            }
          },
          {
            "name": "walletAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "beneficiaryAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "amountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "amountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletSpendList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    walletId: \"wal_sandbox_example0001\",\n    walletAccountId: \"acct_sandbox_example0001\",\n    beneficiaryAccountId: \"acct_sandbox_example0001\",\n    amountFrom: \"1\",\n    amountTo: \"1\",\n    currency: \"SAR\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletSpendListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallet-spends/{walletSpendId}": {
      "get": {
        "operationId": "wallet_spend_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a wallet spend",
        "description": "Retrieve a wallet spend",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet_spend.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "wallet_spend:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet_spend.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "walletSpendId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a wallet spend",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallet Spends"
          ],
          "publicNoun": "Wallet spend",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet_spend"
        ],
        "parameters": [
          {
            "name": "walletSpendId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet spend instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletSpendRetrieve({\n  path: {\n    walletSpendId: \"wspd_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletSpendRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletSpendId": "wspd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet_spend",
                      "status": "created",
                      "fields": {
                        "walletId": "wal_sandbox_example0001",
                        "walletAccountId": "acct_sandbox_example0001",
                        "beneficiaryAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "spendTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallet-spends/{walletSpendId}/post": {
      "post": {
        "operationId": "wallet_spend_post",
        "tags": [
          "noun_instance"
        ],
        "summary": "Post a wallet spend",
        "description": "Settles the spend amount from the wallet account to the beneficiary. Only runs while the wallet is active, so freezing the wallet stops spending without touching the ledger.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet_spend.post",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "wallet_spend:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet_spend.posted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletSpendId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "wallet_spend.posted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Post a wallet spend",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallet Spends"
          ],
          "publicNoun": "Wallet spend",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet_spend"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet_spend.posted",
            "operation": "wallet_spend.post",
            "operationId": "wallet_spend_post",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletSpendPostOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletSpendId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet spend instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletSpendPost({\n  path: {\n    walletSpendId: \"wspd_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "noun_reference_not_found",
          "noun_reference_required",
          "noun_reference_status_forbidden",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletSpendPostOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletSpendId": "wspd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet_spend",
                      "status": "posted",
                      "fields": {
                        "walletId": "wal_sandbox_example0001",
                        "walletAccountId": "acct_sandbox_example0001",
                        "beneficiaryAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "spendTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, noun_reference_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "noun_reference_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, noun_reference_required, noun_reference_status_forbidden, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "noun_reference_required",
              "noun_reference_status_forbidden",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallet-spends/{walletSpendId}/refund": {
      "post": {
        "operationId": "wallet_spend_refund",
        "tags": [
          "noun_instance"
        ],
        "summary": "Refund a wallet spend",
        "description": "Settles the spend amount from the beneficiary back into the wallet account and returns the spend's headroom to the wallet's limit.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet_spend.refund",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "wallet_spend:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet_spend.refunded",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletSpendId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "wallet_spend.refunded"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Refund a wallet spend",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallet Spends"
          ],
          "publicNoun": "Wallet spend",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet_spend"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet_spend.refunded",
            "operation": "wallet_spend.refund",
            "operationId": "wallet_spend_refund",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletSpendRefundOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletSpendId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wspd_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet spend instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletSpendRefund({\n  path: {\n    walletSpendId: \"wspd_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletSpendRefundOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletSpendId": "wspd_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet_spend",
                      "status": "refunded",
                      "fields": {
                        "walletId": "wal_sandbox_example0001",
                        "walletAccountId": "acct_sandbox_example0001",
                        "beneficiaryAccountId": "acct_sandbox_example0001",
                        "amount": "1",
                        "currency": "SAR"
                      },
                      "refs": {
                        "spendTransferId": "resource_sandbox_example0001",
                        "refundTransferId": "ref_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets": {
      "post": {
        "operationId": "wallet_create",
        "tags": [
          "noun_instance"
        ],
        "summary": "Create a wallet",
        "description": "Opens the wallet and provisions its dedicated product account. No money moves until the wallet activates and the holder tops it up.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true,
              "idPath": "holderAccountId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "account.active_month",
            "meters": [
              "account.active_month",
              "account.created.count",
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "wallet.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.created",
            "operation": "wallet.create",
            "operationId": "wallet_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletCreate({\n  body: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    holderAccountId: \"acct_sandbox_example0001\",\n    currency: \"SAR\",\n    limitAmount: \"1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "kyc_tier_insufficient",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_retired",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WalletCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "workspaceId": "wsp_sandbox_example0001",
                    "holderAccountId": "acct_sandbox_example0001",
                    "currency": "SAR",
                    "limitAmount": "1"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "created",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, kyc_tier_insufficient, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "kyc_tier_insufficient",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, ledger_transfer_rejected, noun_retired, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "noun_retired",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "wallet_list",
        "tags": [
          "noun_instance"
        ],
        "summary": "List wallets",
        "description": "List wallets",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "wallet:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List wallets",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "created",
                "active",
                "frozen",
                "closed"
              ]
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "holderAccountId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale account ID",
              "x-hyperscale-reference-filter": {
                "column": "role",
                "values": [
                  "customer_balance"
                ]
              }
            }
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 3,
              "maxLength": 3,
              "pattern": "^[A-Z]{3}$",
              "description": "ISO 4217 currency code"
            }
          },
          {
            "name": "limitAmountFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "limitAmountTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})$",
              "description": "Non-negative minor-unit integer amount serialized as a string (at most 18 digits)"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletList({\n  query: {\n    workspaceId: \"wsp_sandbox_example0001\",\n    status: \"created\",\n    query: \"status=active\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    holderAccountId: \"acct_sandbox_example0001\",\n    currency: \"SAR\",\n    limitAmountFrom: \"1\",\n    limitAmountTo: \"1\",\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}": {
      "get": {
        "operationId": "wallet_retrieve",
        "tags": [
          "noun_instance"
        ],
        "summary": "Retrieve a wallet",
        "description": "Retrieve a wallet",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "wallet:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "read",
              "tenantScoped": true,
              "idPath": "walletId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a wallet",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletRetrieve({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "created",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "wallet_update",
        "tags": [
          "noun_instance"
        ],
        "summary": "Update a wallet",
        "description": "Edits the mutable fields of a wallet (memo) while it is created or active. Omitted fields are left unchanged; identity and lifecycle fields are immutable and rejected at validation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "wallet.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.updated",
            "operation": "wallet.update",
            "operationId": "wallet_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletUpdate({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WalletUpdateBody"
              },
              "examples": {}
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "created",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/activate": {
      "post": {
        "operationId": "wallet_activate",
        "tags": [
          "noun_instance"
        ],
        "summary": "Activate a wallet",
        "description": "Puts the wallet in service, opening top-ups, withdrawals, and spends. No money moves, so this is a pure lifecycle transition.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.activate",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.activated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "wallet.activated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Activate a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.activated",
            "operation": "wallet.activate",
            "operationId": "wallet_activate",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletActivateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletActivate({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletActivateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "active",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/close": {
      "post": {
        "operationId": "wallet_close",
        "tags": [
          "noun_instance"
        ],
        "summary": "Close a wallet",
        "description": "Ends the wallet. Close is refused while the wallet account still holds a settled balance or reserved holds -- withdraw the residual to the holder first -- so the transition itself never moves money.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.close",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.closed",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "wallet.closed"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Close a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.closed",
            "operation": "wallet.close",
            "operationId": "wallet_close",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletCloseOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletClose({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_account_not_drained",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletCloseOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "closed",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, invalid_noun_transition, noun_account_not_drained, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "invalid_noun_transition",
              "noun_account_not_drained",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/freeze": {
      "post": {
        "operationId": "wallet_freeze",
        "tags": [
          "noun_instance"
        ],
        "summary": "Freeze a wallet",
        "description": "Suspends the wallet: top-ups, withdrawals, and spend posting all refuse while frozen. The balance stays held in the wallet account; no money moves. The step freezes the wallet account itself, so the ledger refuses transfer legs against it even outside the wallet's own verbs -- the noun status gates the verbs, the account status is the ledger truth beneath them.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.freeze",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write",
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.frozen",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            },
            {
              "kind": "account",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "wallet.frozen"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Freeze a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.frozen",
            "operation": "wallet.freeze",
            "operationId": "wallet_freeze",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletFreezeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletFreeze({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_not_found",
          "account_status_forbidden",
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletFreezeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "frozen",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_status_forbidden, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_status_forbidden",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/topup": {
      "post": {
        "operationId": "wallet_topup",
        "tags": [
          "noun_instance"
        ],
        "summary": "Top up a wallet",
        "description": "Moves a caller-supplied amount from the holder's funding account into the wallet account. Only available while the wallet is active.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.topup",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.topped_up",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "wallet.topped_up"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Top up a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.topped_up",
            "operation": "wallet.topup",
            "operationId": "wallet_topup",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletTopupOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletTopup({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n  body: {\n    amount: \"1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WalletTopupBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "amount": "1"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletTopupOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "active",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/unfreeze": {
      "post": {
        "operationId": "wallet_unfreeze",
        "tags": [
          "noun_instance"
        ],
        "summary": "Unfreeze a wallet",
        "description": "Returns a frozen wallet to service, reopening top-ups, withdrawals, and spends. No money moves; the step unfreezes the wallet account alongside the noun. Refused while the account carries a system-plane freeze, which only the platform lifts.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.unfreeze",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "account:write",
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.unfrozen",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            },
            {
              "kind": "account",
              "action": "write",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count"
            ]
          },
          "audit": {
            "event": "wallet.unfrozen"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Unfreeze a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.unfrozen",
            "operation": "wallet.unfreeze",
            "operationId": "wallet_unfreeze",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletUnfreezeOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletUnfreeze({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_freeze_plane_forbidden",
          "account_not_found",
          "account_status_forbidden",
          "invalid_credentials",
          "invalid_noun_transition",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "usage_source_conflict"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletUnfreezeOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "active",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, noun_instance_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "noun_instance_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_freeze_plane_forbidden, account_status_forbidden, invalid_noun_transition, operation_not_finalized, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_freeze_plane_forbidden",
              "account_status_forbidden",
              "invalid_noun_transition",
              "operation_not_finalized",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/withdraw": {
      "post": {
        "operationId": "wallet_withdraw",
        "tags": [
          "noun_instance"
        ],
        "summary": "Withdraw from a wallet",
        "description": "Moves a caller-supplied amount from the wallet account back to the holder's funding account. Only available while the wallet is active; the ledger caps the withdrawal at the held balance.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "wallet.withdraw",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write",
          "wallet:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "ledger",
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "wallet.withdrawn",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 30
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "noun_instance",
              "action": "write",
              "tenantScoped": true,
              "idPath": "walletId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {
            "meter": "noun.event.count",
            "meters": [
              "noun.event.count",
              "noun.event.volume_sar",
              "transfer.internal.count",
              "transfer.internal.volume_sar"
            ]
          },
          "audit": {
            "event": "wallet.withdrawn"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Withdraw from a wallet",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Blueprints",
            "Wallets"
          ],
          "publicNoun": "Wallet",
          "resourceRef": "noun_instance",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "wallet"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "wallet.withdrawn",
            "operation": "wallet.withdraw",
            "operationId": "wallet_withdraw",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WalletWithdrawOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "walletId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wal_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Wallet instance ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.walletWithdraw({\n  path: {\n    walletId: \"wal_sandbox_example0001\",\n  },\n  body: {\n    amount: \"1\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_frozen",
          "account_ledger_mapping_conflict",
          "account_not_found",
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "customer_access_compliance_forbidden",
          "customer_access_required",
          "customer_not_found",
          "customer_status_forbidden",
          "destination_account_status_forbidden",
          "entity_not_found",
          "entity_status_forbidden",
          "insufficient_balance",
          "invalid_credentials",
          "invalid_noun_transition",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "noun_instance_not_found",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "source_account_status_forbidden",
          "source_operation_not_found",
          "transfer_destination_role_forbidden",
          "transfer_lineage_conflict",
          "transfer_not_found",
          "transfer_role_pair_forbidden",
          "transfer_source_role_forbidden",
          "transfer_status_forbidden",
          "usage_source_conflict"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WalletWithdrawBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "amount": "1"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletWithdrawOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "walletId": "wal_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "nounId": "wallet",
                      "status": "active",
                      "fields": {
                        "holderAccountId": "acct_sandbox_example0001",
                        "currency": "SAR",
                        "limitAmount": "1"
                      },
                      "refs": {
                        "walletAccountId": "acct_sandbox_example0001",
                        "topupTransferId": "resource_sandbox_example0001",
                        "withdrawTransferId": "resource_sandbox_example0001"
                      },
                      "createdAt": "2026-01-01T00:00:00.000Z",
                      "updatedAt": "2026-01-01T00:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, destination_account_status_forbidden, source_account_status_forbidden, transfer_destination_role_forbidden, transfer_role_pair_forbidden, transfer_source_role_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "destination_account_status_forbidden",
              "source_account_status_forbidden",
              "transfer_destination_role_forbidden",
              "transfer_role_pair_forbidden",
              "transfer_source_role_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, customer_access_compliance_forbidden, customer_access_required, customer_status_forbidden, entity_status_forbidden, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "customer_access_compliance_forbidden",
              "customer_access_required",
              "customer_status_forbidden",
              "entity_status_forbidden",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, account_not_found, customer_not_found, entity_not_found, noun_instance_not_found, source_operation_not_found, transfer_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "account_not_found",
              "customer_not_found",
              "entity_not_found",
              "noun_instance_not_found",
              "source_operation_not_found",
              "transfer_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_frozen, account_ledger_mapping_conflict, cross_tenant_transfer_forbidden, customer_access_compliance_forbidden, insufficient_balance, invalid_noun_transition, ledger_transfer_rejected, operation_not_finalized, transfer_lineage_conflict, transfer_status_forbidden, usage_source_conflict.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_frozen",
              "account_ledger_mapping_conflict",
              "cross_tenant_transfer_forbidden",
              "customer_access_compliance_forbidden",
              "insufficient_balance",
              "invalid_noun_transition",
              "ledger_transfer_rejected",
              "operation_not_finalized",
              "transfer_lineage_conflict",
              "transfer_status_forbidden",
              "usage_source_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints": {
      "post": {
        "operationId": "webhook_endpoint_create",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Create a webhook endpoint",
        "description": "Registers an outbound webhook endpoint for one Product's audit-event delivery and returns the signing secret exactly once in the create response. Sandbox may target local HTTP listeners; live endpoints must use HTTPS.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.create",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.created",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.created"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Create a webhook endpoint",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Never echo, log, or persist the returned secret/key; deliver it to the operator through the product surface."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": true
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.created",
            "operation": "webhook.endpoint.create",
            "operationId": "webhook_endpoint_create",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointCreateOutput"
            }
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointCreate({\n  body: {\n    url: \"https://hooks.example.test/hyperscale\",\n    enabledEvents: [\n      \"account.created\",\n    ],\n    description: \"Ledger events\",\n    workspaceId: \"wsp_sandbox_riyadhresale01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_not_found"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointCreateInput"
              },
              "examples": {
                "default": {
                  "value": {
                    "url": "https://hooks.example.test/hyperscale",
                    "enabledEvents": [
                      "account.created"
                    ],
                    "description": "Ledger events",
                    "workspaceId": "wsp_sandbox_riyadhresale01"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointCreateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "webhookEndpointId": "whend_sandbox_receiver01",
                      "workspaceId": "wsp_sandbox_riyadhresale01",
                      "url": "https://hooks.example.test/hyperscale",
                      "status": "enabled",
                      "audience": "tenant",
                      "entityAccountId": null,
                      "enabledEvents": [
                        "account.created"
                      ],
                      "secretLast4": "0000",
                      "description": "Ledger events",
                      "lastDeliveryStatus": null,
                      "lastDeliveryAt": null,
                      "createdAt": "2026-06-04T00:00:00.000Z",
                      "updatedAt": "2026-06-04T00:00:00.000Z",
                      "signingSecret": "whsec_example000000000000000000000000000000"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "webhook_endpoint_list",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "List webhook endpoints",
        "description": "Lists outbound webhook endpoints for a tenant without exposing signing secret material. Pass workspaceId to narrow the listing to endpoints scoped to that workspace.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "webhook:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List webhook endpoints",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "deleted",
                "disabled",
                "enabled"
              ]
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointList({\n  query: {\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"deleted\",\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}": {
      "get": {
        "operationId": "webhook_endpoint_retrieve",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Retrieve a webhook endpoint",
        "description": "Retrieves one outbound webhook endpoint without exposing signing secret material.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "webhook:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "read",
              "tenantScoped": true,
              "idPath": "webhookEndpointId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a webhook endpoint",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointRetrieve({\n  path: {\n    webhookEndpointId: \"whend_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "item": {
                        "webhookEndpointId": "whend_sandbox_example0001",
                        "tenantId": "ten_sandbox_example0001",
                        "id": "whend_sandbox_example0001",
                        "url": "https://api.hyperscale.example",
                        "status": "deleted",
                        "audience": "entity",
                        "enabledEvents": [
                          "*"
                        ],
                        "secretLast4": "1234",
                        "createdAt": "2026-01-01T00:00:00.000Z",
                        "updatedAt": "2026-01-01T00:00:00.000Z"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "webhook_endpoint_update",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Update a webhook endpoint",
        "description": "Updates an endpoint's delivery URL, enabled event set, or description. The signing secret and workspace scope never change here: rotate the secret with webhook.endpoint.secret.rotate, and create a new endpoint to target a different workspace. The new URL must satisfy the same host policy as create (HTTPS in live, no private or loopback addresses). Deleted endpoints are terminal and cannot be updated.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.update",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.updated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookEndpointId",
              "status": {
                "allowed": [
                  "disabled",
                  "enabled"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.updated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Update a webhook endpoint",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.updated",
            "operation": "webhook.endpoint.update",
            "operationId": "webhook_endpoint_update",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointUpdateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointUpdate({\n  path: {\n    webhookEndpointId: \"whend_sandbox_receiver01\",\n  },\n  body: {\n    url: \"https://hooks.example.test/hyperscale-v2\",\n    reason: \"Receiver moved to the v2 ingestion path\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "webhook_endpoint_lifecycle_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointUpdateBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "url": "https://hooks.example.test/hyperscale-v2",
                    "reason": "Receiver moved to the v2 ingestion path"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointUpdateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "webhookEndpointId": "whend_sandbox_receiver01",
                      "workspaceId": "wsp_sandbox_riyadhresale01",
                      "url": "https://hooks.example.test/hyperscale-v2",
                      "status": "enabled",
                      "audience": "tenant",
                      "entityAccountId": null,
                      "enabledEvents": [
                        "account.created"
                      ],
                      "secretLast4": "0000",
                      "description": "Ledger events",
                      "lastDeliveryStatus": null,
                      "lastDeliveryAt": null,
                      "createdAt": "2026-06-04T00:00:00.000Z",
                      "updatedAt": "2026-06-04T00:05:00.000Z",
                      "reason": "Receiver moved to the v2 ingestion path"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, webhook_endpoint_lifecycle_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "webhook_endpoint_lifecycle_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/delete": {
      "post": {
        "operationId": "webhook_endpoint_delete",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Delete a webhook endpoint",
        "description": "Terminally retires an endpoint: delivery stops immediately, queued deliveries are never attempted, and the endpoint cannot be updated or re-enabled. The row is kept as an audit record (deliveries reference it) but its signing secrets stop verifying new deliveries because none are created.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.delete",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.deleted",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookEndpointId",
              "status": {
                "allowed": [
                  "disabled",
                  "enabled"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.deleted"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Delete a webhook endpoint",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.deleted",
            "operation": "webhook.endpoint.delete",
            "operationId": "webhook_endpoint_delete",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointDeleteOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointDelete({\n  path: {\n    webhookEndpointId: \"whend_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "webhook_endpoint_lifecycle_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointDeleteBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointDeleteOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "webhookEndpointId": "whend_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "disabled",
                      "status": "deleted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, webhook_endpoint_lifecycle_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "webhook_endpoint_lifecycle_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/deliveries": {
      "get": {
        "operationId": "webhook_delivery_list",
        "tags": [
          "webhook_delivery"
        ],
        "summary": "List webhook deliveries",
        "description": "Lists webhook delivery attempts for one endpoint so an operator can find pending, failed, exhausted, or succeeded deliveries. A failed delivery retries on a fixed backoff of 1m, 5m, 30m, 2h, 6h, 24h, and 72h (eight attempts in total) before it is marked exhausted; webhook.delivery.resend queues a fresh attempt at any point. Each item carries the delivered eventType inline; eventId resolves the full envelope via event.retrieve.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.delivery.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "webhook:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.delivery.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_delivery",
              "action": "read",
              "tenantScoped": true
            },
            {
              "kind": "webhook_endpoint",
              "action": "read",
              "tenantScoped": true,
              "idPath": "webhookEndpointId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List webhook deliveries",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook delivery",
          "resourceRef": "webhook_delivery",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "name": "createdFrom",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "createdTo",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "enum": [
                "exhausted",
                "failed",
                "pending",
                "succeeded"
              ]
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookDeliveryList({\n  path: {\n    webhookEndpointId: \"whend_sandbox_receiver01\",\n  },\n  query: {\n    limit: 25,\n    cursor: \"cursor_sandbox_page0001\",\n    createdFrom: \"2026-01-01T00:00:00.000Z\",\n    createdTo: \"2026-02-01T00:00:00.000Z\",\n    status: \"pending\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeliveryListOutput"
                },
                "examples": {
                  "pending_deliveries": {
                    "value": {
                      "items": [
                        {
                          "id": "whdel_sandbox_delivery0001",
                          "webhookDeliveryId": "whdel_sandbox_delivery0001",
                          "tenantId": "ten_sandbox_riyadhresale01",
                          "webhookEndpointId": "whend_sandbox_receiver01",
                          "eventId": "aud_sandbox_event0001",
                          "eventType": "account.created",
                          "attempt": 2,
                          "status": "pending",
                          "createdAt": "2026-06-04T00:05:00.000Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/deliveries/{webhookDeliveryId}/resend": {
      "post": {
        "operationId": "webhook_delivery_resend",
        "tags": [
          "webhook_delivery"
        ],
        "summary": "Resend a webhook delivery",
        "description": "Queues a fresh delivery attempt for one prior webhook delivery within the caller's tenant and environment scope.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.delivery.resend",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.delivery.resent",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "read",
              "tenantScoped": true,
              "idPath": "webhookEndpointId"
            },
            {
              "kind": "webhook_delivery",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookDeliveryId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.delivery.resent"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Resend a webhook delivery",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook delivery",
          "resourceRef": "webhook_delivery",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.delivery.resent",
            "operation": "webhook.delivery.resend",
            "operationId": "webhook_delivery_resend",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookDeliveryResendOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "name": "webhookDeliveryId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whdel_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook delivery ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookDeliveryResend({\n  path: {\n    webhookEndpointId: \"whend_sandbox_receiver01\",\n    webhookDeliveryId: \"whdel_sandbox_delivery0000\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "202": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookDeliveryResendOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "webhookEndpointId": "whend_sandbox_receiver01",
                      "webhookDeliveryId": "whdel_sandbox_delivery0001",
                      "eventId": "aud_sandbox_event0001",
                      "eventType": "account.created",
                      "attempt": 2,
                      "status": "pending",
                      "httpStatus": null,
                      "responseSnippet": null,
                      "nextAttemptAt": null,
                      "deliveredAt": null,
                      "createdAt": "2026-06-04T00:05:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/disable": {
      "post": {
        "operationId": "webhook_endpoint_disable",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Disable a webhook endpoint",
        "description": "Pauses delivery to an enabled endpoint: no new deliveries are created and queued ones are not attempted while it is disabled. The signing secret and configuration are kept. On re-enable, subscribed events from the paused window that are at most seven days old are delivered automatically; use webhook.endpoint.recover for anything older.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.disable",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.disabled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookEndpointId",
              "status": {
                "allowed": [
                  "enabled"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.disabled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Disable a webhook endpoint",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.disabled",
            "operation": "webhook.endpoint.disable",
            "operationId": "webhook_endpoint_disable",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointDisableOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointDisable({\n  path: {\n    webhookEndpointId: \"whend_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "webhook_endpoint_lifecycle_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointDisableBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointDisableOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "webhookEndpointId": "whend_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "enabled",
                      "status": "disabled"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, webhook_endpoint_lifecycle_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "webhook_endpoint_lifecycle_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/enable": {
      "post": {
        "operationId": "webhook_endpoint_enable",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Enable a webhook endpoint",
        "description": "Resumes delivery for a disabled endpoint with its existing URL, event set, and signing secret. Subscribed events from the paused window that are at most seven days old are delivered automatically; use webhook.endpoint.recover for anything older. Deleted endpoints are terminal and cannot be enabled.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.enable",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.enabled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookEndpointId",
              "status": {
                "allowed": [
                  "disabled"
                ]
              }
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.enabled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Enable a webhook endpoint",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.enabled",
            "operation": "webhook.endpoint.enable",
            "operationId": "webhook_endpoint_enable",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointEnableOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointEnable({\n  path: {\n    webhookEndpointId: \"whend_sandbox_example0001\",\n  },\n  body: {\n    reason: \"Customer requested this lifecycle change.\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "webhook_endpoint_lifecycle_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointEnableBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "reason": "Customer requested this lifecycle change."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointEnableOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "webhookEndpointId": "whend_sandbox_example0001",
                      "updatedAt": "2026-01-01T00:00:00.000Z",
                      "reason": "Customer requested this lifecycle change.",
                      "previousStatus": "disabled",
                      "status": "enabled"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized, webhook_endpoint_lifecycle_status_forbidden.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized",
              "webhook_endpoint_lifecycle_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/recover": {
      "post": {
        "operationId": "webhook_endpoint_recover",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Recover webhook deliveries",
        "description": "Queues delivery attempts for matching events since a timestamp that have not succeeded for the endpoint.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.recover",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.recovered",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookEndpointId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.recovered"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Recover webhook deliveries",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.recovered",
            "operation": "webhook.endpoint.recover",
            "operationId": "webhook_endpoint_recover",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointRecoverOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointRecover({\n  path: {\n    webhookEndpointId: \"whend_sandbox_receiver01\",\n  },\n  body: {\n    since: \"2026-06-04T00:00:00.000Z\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookEndpointRecoverBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "since": "2026-06-04T00:00:00.000Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointRecoverOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "webhookEndpointId": "whend_sandbox_receiver01",
                      "since": "2026-06-04T00:00:00.000Z",
                      "recoveredAt": "2026-06-04T00:05:00.000Z",
                      "enqueuedCount": 1,
                      "eventIds": [
                        "aud_sandbox_event0001"
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/webhook-endpoints/{webhookEndpointId}/secret/rotate": {
      "post": {
        "operationId": "webhook_endpoint_secret_rotate",
        "tags": [
          "webhook_endpoint"
        ],
        "summary": "Rotate a webhook endpoint signing secret",
        "description": "Creates a new webhook signing secret, returns it exactly once, and keeps the prior secret active for a short overlap window so in-flight deliveries continue to verify.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "webhook.endpoint.secret.rotate",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T1",
        "x-hyperscale-scopes": [
          "webhook:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "webhook.endpoint.secret.rotated",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "webhook_endpoint",
              "action": "write",
              "tenantScoped": true,
              "idPath": "webhookEndpointId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "audit": {
            "event": "webhook.endpoint.secret.rotated"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Rotate a webhook endpoint signing secret",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input.",
            "Never echo, log, or persist the returned secret/key; deliver it to the operator through the product surface."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": true
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Organization",
            "Webhooks"
          ],
          "publicNoun": "Webhook endpoint",
          "resourceRef": "webhook_endpoint",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [
          "webhooks"
        ],
        "x-hyperscale-event-types": [
          {
            "eventType": "webhook.endpoint.secret.rotated",
            "operation": "webhook.endpoint.secret.rotate",
            "operationId": "webhook_endpoint_secret_rotate",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WebhookEndpointSecretRotateOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "webhookEndpointId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^whend_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale outbound webhook endpoint ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.webhookEndpointSecretRotate({\n  path: {\n    webhookEndpointId: \"whend_sandbox_receiver01\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpointSecretRotateOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_riyadhresale01",
                      "webhookEndpointId": "whend_sandbox_receiver01",
                      "workspaceId": "wsp_sandbox_riyadhresale01",
                      "url": "https://hooks.example.test/hyperscale",
                      "status": "enabled",
                      "audience": "tenant",
                      "entityAccountId": null,
                      "enabledEvents": [
                        "account.created"
                      ],
                      "secretLast4": "0000",
                      "description": "Ledger events",
                      "lastDeliveryStatus": null,
                      "lastDeliveryAt": null,
                      "createdAt": "2026-06-04T00:00:00.000Z",
                      "updatedAt": "2026-06-04T00:00:00.000Z",
                      "signingSecret": "whsec_rotated000000000000000000000000000000",
                      "previousSecretExpiresAt": "2026-06-04T00:05:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/activation": {
      "get": {
        "operationId": "workspace_activation_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve product activation readiness and cost",
        "description": "Returns the product's go-live readiness — whether the product is live and the outstanding activation-review gate tokens (going live is one product-level activation review) — joined with its forward live-cost / required-funding estimate and the blockers standing between it and a self-served go-live cost.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.activation.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.activation.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve product activation readiness and cost",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Go live"
          ],
          "publicNoun": "Product activation",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceActivationRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceActivationRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "environment": "sandbox",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "readiness": {
                        "live": true,
                        "outstandingLiveRequirements": [],
                        "liveUnavailableCapabilities": []
                      },
                      "cost": {
                        "currency": "SAR",
                        "platformMonthlySar": "2500.00",
                        "platformSetupSar": "2500.00",
                        "liveCapableCount": 0,
                        "recurringCharges": [],
                        "usageCharges": [],
                        "estimatedMonthlyFixedSar": "2500.00",
                        "blockers": [],
                        "complete": true
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/balance-sheet": {
      "get": {
        "operationId": "workspace_balance_sheet_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve the product balance sheet",
        "description": "Reads the product's accounting view live from the ledger: liabilities (customer wallet and investment balances held for customers), assets (escrow and pool holding positions), and revenue (earned fees), each aggregated per account role in SAR.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.balance_sheet.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [
          "ledger_read"
        ],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.balance_sheet.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve the product balance sheet",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Money"
          ],
          "publicNoun": "Product balance sheet",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceBalanceSheetRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_dangling",
          "account_ledger_unprovisioned",
          "invalid_credentials",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_environment_invalid",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceBalanceSheetRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "environment": "sandbox",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "asOf": "2026-01-01T00:00:00.000Z",
                      "currency": "SAR",
                      "liabilities": {
                        "total": "1",
                        "lines": []
                      },
                      "assets": {
                        "total": "1",
                        "lines": []
                      },
                      "revenue": {
                        "total": "1",
                        "lines": []
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_dangling, account_ledger_unprovisioned.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_dangling",
              "account_ledger_unprovisioned"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/earn-rates": {
      "get": {
        "operationId": "workspace_earn_rate_list",
        "tags": [
          "workspace"
        ],
        "summary": "List product earn rates",
        "description": "Lists the configured earn rates for a product, one per earnable operation.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.earn.rate.list",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.earn.rates.listed",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "List product earn rates",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Settings",
            "Earnings"
          ],
          "publicNoun": "Product earn rates",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Maximum items to return (1-100). Defaults to 50 when omitted."
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceEarnRateList({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n  query: {\n    limit: 1,\n    cursor: \"cursor_sandbox_page0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "operation_environment_invalid",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceEarnRateListOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/earnings/settlements": {
      "post": {
        "operationId": "workspace_earnings_settle",
        "tags": [
          "workspace"
        ],
        "summary": "Settle product earnings",
        "description": "Moves accumulated earnings from the product revenue account to the tenant settlement account. The ledger rejects settling more than the revenue account holds.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.earnings.settle",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T3",
        "x-hyperscale-scopes": [
          "transfer:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.earnings.settled",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "write",
              "tenantScoped": true,
              "idPath": "workspaceId"
            },
            {
              "kind": "internal_transfer",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "internal_transfer",
            "amountPath": "amount",
            "currencyPath": "currency",
            "deterministicTransferId": "operation",
            "lineage": "none",
            "transferSemantics": "post"
          },
          "metering": {},
          "audit": {
            "event": "workspace.earnings.settled"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous money movement, reversal, correction, or payout requests."
          ],
          "externalProvider": false,
          "moneyMovement": true,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Settle product earnings",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to move money without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "money_movement",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Settings",
            "Earnings"
          ],
          "publicNoun": "Product earnings settlement",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "x-hyperscale-event-types": [
          {
            "eventType": "workspace.earnings.settled",
            "operation": "workspace.earnings.settle",
            "operationId": "workspace_earnings_settle",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WorkspaceEarningsSettleOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceEarningsSettle({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n  body: {\n    amount: \"1\",\n    currency: \"SAR\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_environment_invalid",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WorkspaceEarningsSettleBody"
              },
              "examples": {
                "default": {
                  "value": {
                    "amount": "1",
                    "currency": "SAR"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceEarningsSettleOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "transferId": "trn_sandbox_example0001",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "sourceAccountId": "acct_sandbox_example0001",
                      "destinationAccountId": "acct_sandbox_example0001",
                      "amount": "1",
                      "currency": "SAR",
                      "transferStatus": "posted"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, cross_tenant_transfer_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/guidance": {
      "get": {
        "operationId": "workspace_guidance_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve deterministic product guidance",
        "description": "Returns the ordered, contract-owned guidance predicates for a product, combining activation readiness with operational signals such as active API keys and first activity.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.guidance.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.guidance.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve deterministic product guidance",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Guidance"
          ],
          "publicNoun": "Product guidance",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceGuidanceRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_build_not_found"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceGuidanceRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "items": [],
                      "nextPredicate": "mint_api_key"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_build_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_build_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/margin": {
      "get": {
        "operationId": "workspace_margin_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve the product margin view",
        "description": "Joins the product's frozen plan rate card (the buy side: what the tenant pays Hyperscale per earnable operation) with its configured earn rates (the sell side: what the tenant charges on the same operations) into one per-operation margin line, so the tenant sees what each business event nets before setting prices.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.margin.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.margin.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve the product margin view",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Settings",
            "Earnings"
          ],
          "publicNoun": "Product margin",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceMarginRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceMarginRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "asOf": "2026-01-01T00:00:00.000Z",
                      "items": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The addressed resource, tenant, or route-level target was not found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_not_found",
                        "message": "The requested resource does not exist in the credential's visible scope."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/operation-set": {
      "get": {
        "operationId": "workspace_operation_set_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve a product's frozen public operation set",
        "description": "Returns the latest product build's tenant-visible operation set and its persisted digest. Products built before frozen operation sets return a legacy status. The response never includes the private execution plan.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.operation_set.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "workspace:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.operation_set.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve a product's frozen public operation set",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceOperationSetRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "invalid_credentials",
          "mfa_verification_required",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_build_not_found"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceOperationSetRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "status": "legacy",
                      "workspaceBuildId": "wbld_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed, missing required input, or failed contract validation before execution.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_request",
                        "message": "The request does not match the API reference."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_build_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_build_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "The operation conflicts with the resource's current durable state or idempotency record.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_conflict",
                        "message": "The operation conflicts with the current durable state of the resource."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "A generated read model or backing dependency could not serve the request at this moment.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "A generated read model could not serve the request at this moment."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/treasury": {
      "get": {
        "operationId": "workspace_treasury_retrieve",
        "tags": [
          "workspace"
        ],
        "summary": "Retrieve product treasury balances",
        "description": "Reads the product credit (prepaid spend) and revenue (earnings) account balances live from the ledger.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.treasury.retrieve",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T0",
        "x-hyperscale-scopes": [
          "account:read"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "not_required",
        "x-hyperscale-side-effects": [
          "ledger_read"
        ],
        "x-hyperscale-status-model": [
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.treasury.retrieved",
          "includeEvidence": false
        },
        "x-hyperscale-receipt-evidence": {
          "required": []
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": false
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "read",
              "tenantScoped": true,
              "idPath": "workspaceId"
            },
            {
              "kind": "account",
              "action": "read",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "none"
          },
          "metering": {},
          "pipeline": [
            "validate",
            "authorize"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "resource projection fields"
          ],
          "confirmationRequired": false,
          "destructive": false,
          "escalationNotes": [],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": false,
          "nonIdempotentRisk": false,
          "promptIntent": "Retrieve product treasury balances",
          "readOnly": true,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts."
          ],
          "receiptExpected": false,
          "risk": "read",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Settings",
            "Earnings"
          ],
          "publicNoun": "Product treasury",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceTreasuryRetrieve({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "account_ledger_mapping_dangling",
          "account_ledger_unprovisioned",
          "invalid_credentials",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_environment_invalid",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "responses": {
          "200": {
            "description": "The operation completed and returned its durable result.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTreasuryRetrieveOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "environment": "sandbox",
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "asOf": "2026-01-01T00:00:00.000Z",
                      "credit": {
                        "accountId": "acct_sandbox_example0001",
                        "available": "1",
                        "pending": "1",
                        "settled": "1",
                        "currency": "SAR"
                      },
                      "revenue": {
                        "accountId": "acct_sandbox_example0001",
                        "available": "1",
                        "pending": "1",
                        "settled": "1",
                        "currency": "SAR"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, account_ledger_mapping_dangling, account_ledger_unprovisioned.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "account_ledger_mapping_dangling",
              "account_ledger_unprovisioned"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces/{workspaceId}/treasury/provision": {
      "post": {
        "operationId": "workspace_treasury_provision",
        "tags": [
          "workspace"
        ],
        "summary": "Provision product treasury accounts",
        "description": "Creates the product credit and revenue accounts for a product that is missing them — products created before treasury provisioning existed cannot fund operation costs or accrue earnings. Idempotent: an already-provisioned product returns its existing pair without duplicating accounts.",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "x-hyperscale-operation": "workspace.treasury.provision",
        "x-hyperscale-audiences": [
          "tenant_sdk",
          "tenant_portal",
          "admin_portal"
        ],
        "x-hyperscale-tier": "T2",
        "x-hyperscale-scopes": [
          "workspace:write"
        ],
        "x-hyperscale-environment": "either",
        "x-hyperscale-execution": "runtime",
        "x-hyperscale-idempotency": "required",
        "x-hyperscale-side-effects": [
          "postgres",
          "ledger"
        ],
        "x-hyperscale-status-model": [
          "accepted",
          "succeeded",
          "failed"
        ],
        "x-hyperscale-receipt": {
          "type": "workspace.treasury.provisioned",
          "includeEvidence": true
        },
        "x-hyperscale-receipt-evidence": {
          "required": [
            "local",
            "ledger"
          ]
        },
        "x-hyperscale-journey-step-policy": {
          "allowed": true,
          "maxAttempts": 1,
          "timeoutSeconds": 10
        },
        "x-hyperscale-policy": {
          "principal": "api_key",
          "tenant": {
            "mode": "input",
            "tenantIdPath": "tenantId"
          },
          "resources": [
            {
              "kind": "workspace",
              "action": "write",
              "tenantScoped": true,
              "idPath": "workspaceId"
            },
            {
              "kind": "account",
              "action": "create",
              "tenantScoped": true
            }
          ],
          "ledger": {
            "mode": "account"
          },
          "metering": {},
          "audit": {
            "event": "workspace.treasury.provisioned"
          },
          "pipeline": [
            "validate",
            "authorize",
            "journal",
            "local_commit",
            "finalize_receipt"
          ]
        },
        "x-hyperscale-ai-policy": {
          "allowedContext": [
            "operation contract metadata",
            "user supplied input",
            "idempotency and receipt policy"
          ],
          "confirmationRequired": true,
          "destructive": true,
          "escalationNotes": [
            "Escalate ambiguous, irreversible, or scope-expanding requests to modify, suspend, or close existing resources."
          ],
          "externalProvider": false,
          "moneyMovement": false,
          "mutation": true,
          "nonIdempotentRisk": false,
          "promptIntent": "Provision product treasury accounts",
          "readOnly": false,
          "refusalNotes": [
            "Refuse to fabricate tenant, account, provider, receipt, or trust facts.",
            "Refuse to modify, suspend, disable, or close existing resource state without explicit user confirmation and valid operation input."
          ],
          "receiptExpected": true,
          "risk": "mutation",
          "sensitiveResult": false
        },
        "x-hyperscale-surface": {
          "navPath": [
            "Workspace",
            "Settings",
            "Earnings"
          ],
          "publicNoun": "Product treasury",
          "resourceRef": "workspace",
          "visibility": "public"
        },
        "x-hyperscale-capability-ids": [],
        "x-hyperscale-event-types": [
          {
            "eventType": "workspace.treasury.provisioned",
            "operation": "workspace.treasury.provision",
            "operationId": "workspace_treasury_provision",
            "status": "succeeded",
            "statusField": "status",
            "statusModel": [
              "accepted",
              "succeeded",
              "failed"
            ],
            "payload": {
              "$ref": "#/components/schemas/WorkspaceTreasuryProvisionOutput"
            }
          }
        ],
        "parameters": [
          {
            "name": "workspaceId",
            "in": "path",
            "required": true,
            "schema": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "type": "string",
              "pattern": "^wsp_(sandbox|live)_[a-z0-9]{8,64}$",
              "description": "Hyperscale workspace ID"
            }
          },
          {
            "$ref": "#/components/parameters/HyperscaleEnvironment"
          },
          {
            "$ref": "#/components/parameters/RequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "x-codeSamples": [
          {
            "lang": "ts",
            "label": "TypeScript SDK",
            "source": "// @hyperscale/tenant-sdk-your-capabilities stands in for your Kit's own package name.\n// Your exact name is the \"name\" field of sdks/typescript/package.json\n// in the unpacked Kit.\nimport { createHyperscaleSdk } from \"@hyperscale/tenant-sdk-your-capabilities\";\n\nconst hyperscale = createHyperscaleSdk({\n  environment: \"sandbox\",\n  auth: () => process.env.HYPERSCALE_API_KEY ?? \"\",\n});\n\nconst result = await hyperscale.workspaceTreasuryProvision({\n  path: {\n    workspaceId: \"wsp_sandbox_example0001\",\n  },\n});"
          }
        ],
        "x-hyperscale-errors": [
          "cross_tenant_transfer_forbidden",
          "currency_mismatch",
          "insufficient_balance",
          "invalid_credentials",
          "ledger_transfer_rejected",
          "ledger_unavailable",
          "mfa_verification_required",
          "operation_environment_invalid",
          "operation_not_finalized",
          "session_expired",
          "session_required",
          "session_revoked",
          "workspace_context_forbidden",
          "workspace_context_mismatch",
          "workspace_context_owner_mismatch",
          "workspace_context_required",
          "workspace_not_found",
          "workspace_scope_required",
          "workspace_scope_unsupported",
          "workspace_status_forbidden"
        ],
        "responses": {
          "201": {
            "description": "The operation completed and returned its durable result.",
            "headers": {
              "hyperscale-operation-id": {
                "description": "Durable Hyperscale operation ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              },
              "hyperscale-receipt-id": {
                "description": "Durable Hyperscale receipt ID for the completed mutation.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspaceTreasuryProvisionOutput"
                },
                "examples": {
                  "default": {
                    "value": {
                      "tenantId": "ten_sandbox_example0001",
                      "workspaceId": "wsp_sandbox_example0001",
                      "treasuryStatus": "provisioned",
                      "accounts": [
                        {
                          "accountId": "acct_sandbox_example0001",
                          "role": "workspace_credit",
                          "currency": "SAR"
                        },
                        {
                          "accountId": "acct_sandbox_example0001",
                          "role": "workspace_revenue",
                          "currency": "SAR"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Contract-declared domain errors: idempotency_required, invalid_request, validation_failed, currency_mismatch, operation_environment_invalid, workspace_context_forbidden, workspace_context_mismatch, workspace_context_owner_mismatch, workspace_context_required, workspace_scope_required, workspace_scope_unsupported.",
            "x-hyperscale-error-codes": [
              "idempotency_required",
              "invalid_request",
              "validation_failed",
              "currency_mismatch",
              "operation_environment_invalid",
              "workspace_context_forbidden",
              "workspace_context_mismatch",
              "workspace_context_owner_mismatch",
              "workspace_context_required",
              "workspace_scope_required",
              "workspace_scope_unsupported"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_required",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Contract-declared domain errors: invalid_credentials, session_expired, session_required, session_revoked.",
            "x-hyperscale-error-codes": [
              "invalid_credentials",
              "session_expired",
              "session_required",
              "session_revoked"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "invalid_credentials",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Contract-declared domain errors: csrf_token_invalid, missing_required_permission, missing_required_scope, missing_required_workspace_capability, operation_not_allowed, product_access_suspended, product_activation_required, system_principal_required, tenant_mismatch, unauthorized, mfa_verification_required, workspace_status_forbidden.",
            "x-hyperscale-error-codes": [
              "csrf_token_invalid",
              "missing_required_permission",
              "missing_required_scope",
              "missing_required_workspace_capability",
              "operation_not_allowed",
              "product_access_suspended",
              "product_activation_required",
              "system_principal_required",
              "tenant_mismatch",
              "unauthorized",
              "mfa_verification_required",
              "workspace_status_forbidden"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "csrf_token_invalid",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Contract-declared domain errors: not_found, resource_not_found, tenant_not_found, workspace_not_found.",
            "x-hyperscale-error-codes": [
              "not_found",
              "resource_not_found",
              "tenant_not_found",
              "workspace_not_found"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "not_found",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Contract-declared domain errors: idempotency_conflict, state_conflict, cross_tenant_transfer_forbidden, insufficient_balance, ledger_transfer_rejected, operation_not_finalized.",
            "x-hyperscale-error-codes": [
              "idempotency_conflict",
              "state_conflict",
              "cross_tenant_transfer_forbidden",
              "insufficient_balance",
              "ledger_transfer_rejected",
              "operation_not_finalized"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "idempotency_conflict",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "413": {
            "description": "The request body exceeded Hyperscale's accepted payload size.",
            "x-hyperscale-error-codes": [
              "request_body_too_large"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "request_body_too_large",
                        "message": "The JSON request body exceeded Hyperscale's accepted payload size."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request is well-formed but violates a business-state constraint.",
            "x-hyperscale-error-codes": [
              "state_constraint_failed"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "state_constraint_failed",
                        "message": "The request is syntactically valid but violates a business-state constraint."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "The caller exceeded a request rate or plan-meter ceiling and must back off before retrying.",
            "x-hyperscale-error-codes": [
              "rate_limited"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "rate_limited",
                        "message": "The caller exceeded Hyperscale's fair use request rate for its credential, or its IP address when unauthenticated."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Hyperscale encountered an unexpected internal error.",
            "x-hyperscale-error-codes": [
              "internal_error"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "internal_error",
                        "message": "Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Contract-declared domain errors: resource_reader_unavailable, ledger_unavailable.",
            "x-hyperscale-error-codes": [
              "resource_reader_unavailable",
              "ledger_unavailable"
            ],
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HyperscaleError"
                },
                "examples": {
                  "error": {
                    "value": {
                      "error": {
                        "code": "resource_reader_unavailable",
                        "message": "See the error catalog entry for this code."
                      },
                      "requestId": "req_sandbox_example0001"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
